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>
61 using std::shared_ptr;
62 using std::make_shared;
63 using boost::optional;
64 using std::dynamic_pointer_cast;
65 using boost::algorithm::trim;
66 using dcp::raw_convert;
68 Config* Config::_instance = 0;
69 int const Config::_current_version = 3;
70 boost::signals2::signal<void ()> Config::FailedToLoad;
71 boost::signals2::signal<void (string)> Config::Warning;
72 boost::signals2::signal<bool (Config::BadReason)> Config::Bad;
74 /** Construct default configuration */
76 /* DKDMs are not considered a thing to reset on set_defaults() */
77 : _dkdms (new DKDMGroup ("root"))
83 Config::set_defaults ()
85 _master_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
86 _server_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
87 _server_port_base = 6192;
88 _use_any_servers = true;
90 _only_servers_encode = false;
91 _tms_protocol = FileTransferProtocol::SCP;
96 _allow_any_dcp_frame_rate = false;
97 _allow_any_container = false;
98 _show_experimental_audio_processors = false;
99 _language = optional<string> ();
100 _default_still_length = 10;
101 _default_container = Ratio::from_id ("185");
102 _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
103 _default_dcp_audio_channels = 6;
104 _default_j2k_bandwidth = 150000000;
105 _default_audio_delay = 0;
106 _default_interop = false;
107 _upload_after_make_dcp = false;
110 _mail_protocol = EmailProtocol::AUTO;
116 _notification_from = "";
117 _notification_to = "";
118 _notification_cc.clear ();
119 _notification_bcc = "";
120 _check_for_updates = false;
121 _check_for_test_updates = false;
122 _maximum_j2k_bandwidth = 250000000;
123 _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR | LogEntry::TYPE_DISK;
124 _analyse_ebur128 = true;
125 _automatic_audio_analysis = false;
126 #ifdef DCPOMATIC_WINDOWS
127 _win32_console = false;
129 _cinemas_file = path ("cinemas.xml");
130 _dkdm_recipients_file = path ("dkdm_recipients.xml");
131 _show_hints_before_make_dcp = true;
132 _confirm_kdm_email = true;
133 _kdm_container_name_format = dcp::NameFormat ("KDM %f %c");
134 _kdm_filename_format = dcp::NameFormat ("KDM %f %c %s");
135 _dkdm_filename_format = dcp::NameFormat ("DKDM %f %c %s");
136 _dcp_metadata_filename_format = dcp::NameFormat ("%t");
137 _dcp_asset_filename_format = dcp::NameFormat ("%t");
138 _jump_to_selected = true;
139 for (int i = 0; i < NAG_COUNT; ++i) {
143 _sound_output = optional<string> ();
144 _last_kdm_write_type = KDM_WRITE_FLAT;
145 _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
147 /* I think the scaling factor here should be the ratio of the longest frame
148 encode time to the shortest; if the thread count is T, longest time is L
149 and the shortest time S we could encode L/S frames per thread whilst waiting
150 for the L frame to encode so we might have to store LT/S frames.
152 However we don't want to use too much memory, so keep it a bit lower than we'd
153 perhaps like. A J2K frame is typically about 1Mb so 3 here will mean we could
154 use about 240Mb with 72 encoding threads.
156 _frames_in_memory_multiplier = 3;
157 _decode_reduction = optional<int>();
158 _default_notify = false;
159 for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
160 _notification[i] = false;
162 _barco_username = optional<string>();
163 _barco_password = optional<string>();
164 _christie_username = optional<string>();
165 _christie_password = optional<string>();
166 _gdc_username = optional<string>();
167 _gdc_password = optional<string>();
168 _player_mode = PLAYER_MODE_WINDOW;
170 _video_view_type = VIDEO_VIEW_SIMPLE;
171 _respect_kdm_validity_periods = true;
172 _player_activity_log_file = boost::none;
173 _player_debug_log_file = boost::none;
174 _player_content_directory = boost::none;
175 _player_playlist_directory = boost::none;
176 _player_kdm_directory = boost::none;
177 _audio_mapping = boost::none;
178 _minimum_frame_size = 65536;
179 _custom_languages.clear ();
181 _allowed_dcp_frame_rates.clear ();
182 _allowed_dcp_frame_rates.push_back (24);
183 _allowed_dcp_frame_rates.push_back (25);
184 _allowed_dcp_frame_rates.push_back (30);
185 _allowed_dcp_frame_rates.push_back (48);
186 _allowed_dcp_frame_rates.push_back (50);
187 _allowed_dcp_frame_rates.push_back (60);
189 set_kdm_email_to_default ();
190 set_notification_email_to_default ();
191 set_cover_sheet_to_default ();
195 Config::restore_defaults ()
197 Config::instance()->set_defaults ();
198 Config::instance()->changed ();
201 shared_ptr<dcp::CertificateChain>
202 Config::create_certificate_chain ()
204 return make_shared<dcp::CertificateChain> (
208 ".dcpomatic.smpte-430-2.ROOT",
209 ".dcpomatic.smpte-430-2.INTERMEDIATE",
210 "CS.dcpomatic.smpte-430-2.LEAF"
217 /* Make a copy of the configuration */
220 while (n < 100 && boost::filesystem::exists(path(String::compose("config.xml.%1", n)))) {
224 boost::filesystem::copy_file(path("config.xml", false), path(String::compose("config.xml.%1", n), false));
225 boost::filesystem::copy_file(path("cinemas.xml", false), path(String::compose("cinemas.xml.%1", n), false));
226 boost::filesystem::copy_file(path("dkdm_recipients.xml", false), path(String::compose("dkdm_recipients.xml.%1", n), false));
234 cxml::Document f ("Config");
235 f.read_file (config_file ());
237 auto version = f.optional_number_child<int> ("Version");
238 if (version && *version < _current_version) {
239 /* Back up the old config before we re-write it in a back-incompatible way */
243 if (f.optional_number_child<int>("NumLocalEncodingThreads")) {
244 _master_encoding_threads = _server_encoding_threads = f.optional_number_child<int>("NumLocalEncodingThreads").get();
246 _master_encoding_threads = f.number_child<int>("MasterEncodingThreads");
247 _server_encoding_threads = f.number_child<int>("ServerEncodingThreads");
250 _default_directory = f.optional_string_child ("DefaultDirectory");
251 if (_default_directory && _default_directory->empty ()) {
252 /* We used to store an empty value for this to mean "none set" */
253 _default_directory = boost::optional<boost::filesystem::path> ();
256 auto b = f.optional_number_child<int> ("ServerPort");
258 b = f.optional_number_child<int> ("ServerPortBase");
260 _server_port_base = b.get ();
262 auto u = f.optional_bool_child ("UseAnyServers");
263 _use_any_servers = u.get_value_or (true);
265 for (auto i: f.node_children("Server")) {
266 if (i->node_children("HostName").size() == 1) {
267 _servers.push_back (i->string_child ("HostName"));
269 _servers.push_back (i->content ());
273 _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
274 _tms_protocol = static_cast<FileTransferProtocol>(f.optional_number_child<int>("TMSProtocol").get_value_or(static_cast<int>(FileTransferProtocol::SCP)));
275 _tms_ip = f.string_child ("TMSIP");
276 _tms_path = f.string_child ("TMSPath");
277 _tms_user = f.string_child ("TMSUser");
278 _tms_password = f.string_child ("TMSPassword");
280 _language = f.optional_string_child ("Language");
282 auto c = f.optional_string_child ("DefaultContainer");
284 _default_container = Ratio::from_id (c.get ());
287 if (_default_container && !_default_container->used_for_container()) {
288 Warning (_("Your default container is not valid and has been changed to Flat (1.85:1)"));
289 _default_container = Ratio::from_id ("185");
292 _default_dcp_content_type = DCPContentType::from_isdcf_name(f.optional_string_child("DefaultDCPContentType").get_value_or("FTR"));
293 _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
295 if (f.optional_string_child ("DCPMetadataIssuer")) {
296 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
297 } else if (f.optional_string_child ("DCPIssuer")) {
298 _dcp_issuer = f.string_child ("DCPIssuer");
301 auto up = f.optional_bool_child("UploadAfterMakeDCP");
303 up = f.optional_bool_child("DefaultUploadAfterMakeDCP");
305 _upload_after_make_dcp = up.get_value_or (false);
306 _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
307 _dcp_company_name = f.optional_string_child("DCPCompanyName").get_value_or("");
308 _dcp_product_name = f.optional_string_child("DCPProductName").get_value_or("");
309 _dcp_product_version = f.optional_string_child("DCPProductVersion").get_value_or("");
310 _dcp_j2k_comment = f.optional_string_child("DCPJ2KComment").get_value_or("");
312 _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
313 _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
314 _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
315 _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
316 _default_kdm_directory = f.optional_string_child("DefaultKDMDirectory");
318 /* Read any cinemas that are still lying around in the config file
319 * from an old version.
323 _mail_server = f.string_child ("MailServer");
324 _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
327 /* Make sure this matches the code in write_config */
328 string const protocol = f.optional_string_child("MailProtocol").get_value_or("Auto");
329 if (protocol == "Auto") {
330 _mail_protocol = EmailProtocol::AUTO;
331 } else if (protocol == "Plain") {
332 _mail_protocol = EmailProtocol::PLAIN;
333 } else if (protocol == "STARTTLS") {
334 _mail_protocol = EmailProtocol::STARTTLS;
335 } else if (protocol == "SSL") {
336 _mail_protocol = EmailProtocol::SSL;
340 _mail_user = f.optional_string_child("MailUser").get_value_or ("");
341 _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
343 _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
344 _kdm_from = f.string_child ("KDMFrom");
345 for (auto i: f.node_children("KDMCC")) {
346 if (!i->content().empty()) {
347 _kdm_cc.push_back (i->content ());
350 _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
351 _kdm_email = f.string_child ("KDMEmail");
353 _notification_subject = f.optional_string_child("NotificationSubject").get_value_or(_("DCP-o-matic notification"));
354 _notification_from = f.optional_string_child("NotificationFrom").get_value_or("");
355 _notification_to = f.optional_string_child("NotificationTo").get_value_or("");
356 for (auto i: f.node_children("NotificationCC")) {
357 if (!i->content().empty()) {
358 _notification_cc.push_back (i->content ());
361 _notification_bcc = f.optional_string_child("NotificationBCC").get_value_or("");
362 if (f.optional_string_child("NotificationEmail")) {
363 _notification_email = f.string_child("NotificationEmail");
366 _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
367 _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
369 _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
370 _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
371 _allow_any_container = f.optional_bool_child ("AllowAnyContainer").get_value_or (false);
372 _show_experimental_audio_processors = f.optional_bool_child ("ShowExperimentalAudioProcessors").get_value_or (false);
374 _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
375 _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
376 _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
377 #ifdef DCPOMATIC_WINDOWS
378 _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
381 for (auto i: f.node_children("History")) {
382 _history.push_back (i->content ());
385 for (auto i: f.node_children("PlayerHistory")) {
386 _player_history.push_back (i->content ());
389 auto signer = f.optional_node_child ("Signer");
391 auto c = make_shared<dcp::CertificateChain>();
392 /* Read the signing certificates and private key in from the config file */
393 for (auto i: signer->node_children ("Certificate")) {
394 c->add (dcp::Certificate (i->content ()));
396 c->set_key (signer->string_child ("PrivateKey"));
399 /* Make a new set of signing certificates and key */
400 _signer_chain = create_certificate_chain ();
403 auto decryption = f.optional_node_child ("Decryption");
405 auto c = make_shared<dcp::CertificateChain>();
406 for (auto i: decryption->node_children ("Certificate")) {
407 c->add (dcp::Certificate (i->content ()));
409 c->set_key (decryption->string_child ("PrivateKey"));
410 _decryption_chain = c;
412 _decryption_chain = create_certificate_chain ();
415 /* These must be done before we call Bad as that might set one
418 for (auto i: f.node_children("Nagged")) {
419 auto const id = i->number_attribute<int>("Id");
420 if (id >= 0 && id < NAG_COUNT) {
421 _nagged[id] = raw_convert<int>(i->content());
425 optional<BadReason> bad;
427 for (auto const& i: _signer_chain->unordered()) {
428 if (i.has_utf8_strings()) {
429 bad = BAD_SIGNER_UTF8_STRINGS;
433 if (!_signer_chain->chain_valid() || !_signer_chain->private_key_valid()) {
434 bad = BAD_SIGNER_INCONSISTENT;
437 if (!_decryption_chain->chain_valid() || !_decryption_chain->private_key_valid()) {
438 bad = BAD_DECRYPTION_INCONSISTENT;
442 auto const remake = Bad(*bad);
443 if (remake && *remake) {
445 case BAD_SIGNER_UTF8_STRINGS:
446 case BAD_SIGNER_INCONSISTENT:
447 _signer_chain = create_certificate_chain ();
449 case BAD_DECRYPTION_INCONSISTENT:
450 _decryption_chain = create_certificate_chain ();
456 if (f.optional_node_child("DKDMGroup")) {
457 /* New-style: all DKDMs in a group */
458 _dkdms = dynamic_pointer_cast<DKDMGroup> (DKDMBase::read (f.node_child("DKDMGroup")));
460 /* Old-style: one or more DKDM nodes */
461 _dkdms.reset (new DKDMGroup ("root"));
462 for (auto i: f.node_children("DKDM")) {
463 _dkdms->add (DKDMBase::read (i));
466 _cinemas_file = f.optional_string_child("CinemasFile").get_value_or (path ("cinemas.xml").string ());
467 _dkdm_recipients_file = f.optional_string_child("DKDMRecipientsFile").get_value_or (path("dkdm_recipients.xml").string());
468 _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
469 _confirm_kdm_email = f.optional_bool_child("ConfirmKDMEmail").get_value_or (true);
470 _kdm_container_name_format = dcp::NameFormat (f.optional_string_child("KDMContainerNameFormat").get_value_or ("KDM %f %c"));
471 _kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
472 _dkdm_filename_format = dcp::NameFormat (f.optional_string_child("DKDMFilenameFormat").get_value_or("DKDM %f %c %s"));
473 _dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t"));
474 _dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t"));
475 _jump_to_selected = f.optional_bool_child("JumpToSelected").get_value_or (true);
476 /* The variable was renamed but not the XML tag */
477 _sound = f.optional_bool_child("PreviewSound").get_value_or (true);
478 _sound_output = f.optional_string_child("PreviewSoundOutput");
479 if (f.optional_string_child("CoverSheet")) {
480 _cover_sheet = f.optional_string_child("CoverSheet").get();
482 _last_player_load_directory = f.optional_string_child("LastPlayerLoadDirectory");
483 if (f.optional_string_child("LastKDMWriteType")) {
484 if (f.optional_string_child("LastKDMWriteType").get() == "flat") {
485 _last_kdm_write_type = KDM_WRITE_FLAT;
486 } else if (f.optional_string_child("LastKDMWriteType").get() == "folder") {
487 _last_kdm_write_type = KDM_WRITE_FOLDER;
488 } else if (f.optional_string_child("LastKDMWriteType").get() == "zip") {
489 _last_kdm_write_type = KDM_WRITE_ZIP;
492 if (f.optional_string_child("LastDKDMWriteType")) {
493 if (f.optional_string_child("LastDKDMWriteType").get() == "internal") {
494 _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
495 } else if (f.optional_string_child("LastDKDMWriteType").get() == "file") {
496 _last_dkdm_write_type = DKDM_WRITE_FILE;
499 _frames_in_memory_multiplier = f.optional_number_child<int>("FramesInMemoryMultiplier").get_value_or(3);
500 _decode_reduction = f.optional_number_child<int>("DecodeReduction");
501 _default_notify = f.optional_bool_child("DefaultNotify").get_value_or(false);
503 for (auto i: f.node_children("Notification")) {
504 int const id = i->number_attribute<int>("Id");
505 if (id >= 0 && id < NOTIFICATION_COUNT) {
506 _notification[id] = raw_convert<int>(i->content());
510 _barco_username = f.optional_string_child("BarcoUsername");
511 _barco_password = f.optional_string_child("BarcoPassword");
512 _christie_username = f.optional_string_child("ChristieUsername");
513 _christie_password = f.optional_string_child("ChristiePassword");
514 _gdc_username = f.optional_string_child("GDCUsername");
515 _gdc_password = f.optional_string_child("GDCPassword");
517 auto pm = f.optional_string_child("PlayerMode");
518 if (pm && *pm == "window") {
519 _player_mode = PLAYER_MODE_WINDOW;
520 } else if (pm && *pm == "full") {
521 _player_mode = PLAYER_MODE_FULL;
522 } else if (pm && *pm == "dual") {
523 _player_mode = PLAYER_MODE_DUAL;
526 _image_display = f.optional_number_child<int>("ImageDisplay").get_value_or(0);
527 auto vc = f.optional_string_child("VideoViewType");
528 if (vc && *vc == "opengl") {
529 _video_view_type = VIDEO_VIEW_OPENGL;
530 } else if (vc && *vc == "simple") {
531 _video_view_type = VIDEO_VIEW_SIMPLE;
533 _respect_kdm_validity_periods = f.optional_bool_child("RespectKDMValidityPeriods").get_value_or(true);
534 /* PlayerLogFile is old name */
535 _player_activity_log_file = f.optional_string_child("PlayerLogFile");
536 if (!_player_activity_log_file) {
537 _player_activity_log_file = f.optional_string_child("PlayerActivityLogFile");
539 _player_debug_log_file = f.optional_string_child("PlayerDebugLogFile");
540 _player_content_directory = f.optional_string_child("PlayerContentDirectory");
541 _player_playlist_directory = f.optional_string_child("PlayerPlaylistDirectory");
542 _player_kdm_directory = f.optional_string_child("PlayerKDMDirectory");
544 if (f.optional_node_child("AudioMapping")) {
545 _audio_mapping = AudioMapping (f.node_child("AudioMapping"), Film::current_state_version);
548 _minimum_frame_size = f.optional_number_child<int>("MinimumFrameSize").get_value_or(65536);
550 for (auto i: f.node_children("CustomLanguage")) {
552 /* This will fail if it's called before dcp::init() as it won't recognise the
553 * tag. That's OK because the Config will be reloaded again later.
555 _custom_languages.push_back (dcp::LanguageTag(i->content()));
556 } catch (std::runtime_error& e) {}
559 if (boost::filesystem::exists (_cinemas_file)) {
560 cxml::Document f ("Cinemas");
561 f.read_file (_cinemas_file);
565 if (boost::filesystem::exists (_dkdm_recipients_file)) {
566 cxml::Document f ("DKDMRecipients");
567 f.read_file (_dkdm_recipients_file);
568 read_dkdm_recipients (f);
572 if (have_existing ("config.xml")) {
574 /* We have a config file but it didn't load */
578 /* Make a new set of signing certificates and key */
579 _signer_chain = create_certificate_chain ();
580 /* And similar for decryption of KDMs */
581 _decryption_chain = create_certificate_chain ();
585 /** @return Singleton instance */
589 if (_instance == 0) {
590 _instance = new Config;
597 /** Write our configuration to disk */
599 Config::write () const
603 write_dkdm_recipients ();
607 Config::write_config () const
610 auto root = doc.create_root_node ("Config");
612 /* [XML] Version The version number of the configuration file format. */
613 root->add_child("Version")->add_child_text (raw_convert<string>(_current_version));
614 /* [XML] MasterEncodingThreads Number of encoding threads to use when running as master. */
615 root->add_child("MasterEncodingThreads")->add_child_text (raw_convert<string> (_master_encoding_threads));
616 /* [XML] ServerEncodingThreads Number of encoding threads to use when running as server. */
617 root->add_child("ServerEncodingThreads")->add_child_text (raw_convert<string> (_server_encoding_threads));
618 if (_default_directory) {
619 /* [XML:opt] DefaultDirectory Default directory when creating a new film in the GUI. */
620 root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ());
622 /* [XML] ServerPortBase Port number to use for frame encoding requests. <code>ServerPortBase</code> + 1 and
623 <code>ServerPortBase</code> + 2 are used for querying servers. <code>ServerPortBase</code> + 3 is used
624 by the batch converter to listen for job requests.
626 root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
627 /* [XML] UseAnyServers 1 to broadcast to look for encoding servers to use, 0 to use only those configured. */
628 root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
630 for (auto i: _servers) {
631 /* [XML:opt] Server IP address or hostname of an encoding server to use; you can use as many of these tags
634 root->add_child("Server")->add_child_text (i);
637 /* [XML] OnlyServersEncode 1 to set the master to do decoding of source content no JPEG2000 encoding; all encoding
638 is done by the encoding servers. 0 to set the master to do some encoding as well as coordinating the job.
640 root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
641 /* [XML] TMSProtocol Protocol to use to copy files to a TMS; 0 to use SCP, 1 for FTP. */
642 root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
643 /* [XML] TMSIP IP address of TMS. */
644 root->add_child("TMSIP")->add_child_text (_tms_ip);
645 /* [XML] TMSPath Path on the TMS to copy files to. */
646 root->add_child("TMSPath")->add_child_text (_tms_path);
647 /* [XML] TMSUser Username to log into the TMS with. */
648 root->add_child("TMSUser")->add_child_text (_tms_user);
649 /* [XML] TMSPassword Password to log into the TMS with. */
650 root->add_child("TMSPassword")->add_child_text (_tms_password);
652 /* [XML:opt] Language Language to use in the GUI e.g. <code>fr_FR</code>. */
653 root->add_child("Language")->add_child_text (_language.get());
655 if (_default_container) {
656 /* [XML:opt] DefaultContainer ID of default container
657 to use when creating new films (<code>185</code>,<code>239</code> or
660 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
662 if (_default_dcp_content_type) {
663 /* [XML:opt] DefaultDCPContentType Default content type ot use when creating new films (<code>FTR</code>, <code>SHR</code>,
664 <code>TLR</code>, <code>TST</code>, <code>XSN</code>, <code>RTG</code>, <code>TSR</code>, <code>POL</code>,
665 <code>PSA</code> or <code>ADV</code>). */
666 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
668 /* [XML] DefaultDCPAudioChannels Default number of audio channels to use when creating new films. */
669 root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
670 /* [XML] DCPIssuer Issuer text to write into CPL files. */
671 root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
672 /* [XML] DCPCreator Creator text to write into CPL files. */
673 root->add_child("DCPCreator")->add_child_text (_dcp_creator);
674 /* [XML] Company name to write into MXF files. */
675 root->add_child("DCPCompanyName")->add_child_text (_dcp_company_name);
676 /* [XML] Product name to write into MXF files. */
677 root->add_child("DCPProductName")->add_child_text (_dcp_product_name);
678 /* [XML] Product version to write into MXF files. */
679 root->add_child("DCPProductVersion")->add_child_text (_dcp_product_version);
680 /* [XML] Comment to write into JPEG2000 data. */
681 root->add_child("DCPJ2KComment")->add_child_text (_dcp_j2k_comment);
682 /* [XML] UploadAfterMakeDCP 1 to upload to a TMS after making a DCP, 0 for no upload. */
683 root->add_child("UploadAfterMakeDCP")->add_child_text (_upload_after_make_dcp ? "1" : "0");
685 /* [XML] DefaultStillLength Default length (in seconds) for still images in new films. */
686 root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
687 /* [XML] DefaultJ2KBandwidth Default bitrate (in bits per second) for JPEG2000 data in new films. */
688 root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
689 /* [XML] DefaultAudioDelay Default delay to apply to audio (positive moves audio later) in milliseconds. */
690 root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
691 /* [XML] DefaultInterop 1 to default new films to Interop, 0 for SMPTE. */
692 root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
693 if (_default_kdm_directory) {
694 /* [XML:opt] DefaultKDMDirectory Default directory to write KDMs to. */
695 root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ());
697 /* [XML] MailServer Hostname of SMTP server to use. */
698 root->add_child("MailServer")->add_child_text (_mail_server);
699 /* [XML] MailPort Port number to use on SMTP server. */
700 root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
701 /* [XML] MailProtocol Protocol to use on SMTP server (Auto, Plain, STARTTLS or SSL) */
702 switch (_mail_protocol) {
703 case EmailProtocol::AUTO:
704 root->add_child("MailProtocol")->add_child_text("Auto");
706 case EmailProtocol::PLAIN:
707 root->add_child("MailProtocol")->add_child_text("Plain");
709 case EmailProtocol::STARTTLS:
710 root->add_child("MailProtocol")->add_child_text("STARTTLS");
712 case EmailProtocol::SSL:
713 root->add_child("MailProtocol")->add_child_text("SSL");
716 /* [XML] MailUser Username to use on SMTP server. */
717 root->add_child("MailUser")->add_child_text (_mail_user);
718 /* [XML] MailPassword Password to use on SMTP server. */
719 root->add_child("MailPassword")->add_child_text (_mail_password);
721 /* [XML] KDMSubject Subject to use for KDM emails. */
722 root->add_child("KDMSubject")->add_child_text (_kdm_subject);
723 /* [XML] KDMFrom From address to use for KDM emails. */
724 root->add_child("KDMFrom")->add_child_text (_kdm_from);
725 for (auto i: _kdm_cc) {
726 /* [XML] KDMCC CC address to use for KDM emails; you can use as many of these tags as you like. */
727 root->add_child("KDMCC")->add_child_text (i);
729 /* [XML] KDMBCC BCC address to use for KDM emails. */
730 root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
731 /* [XML] KDMEmail Text of KDM email. */
732 root->add_child("KDMEmail")->add_child_text (_kdm_email);
734 /* [XML] NotificationSubject Subject to use for notification emails. */
735 root->add_child("NotificationSubject")->add_child_text (_notification_subject);
736 /* [XML] NotificationFrom From address to use for notification emails. */
737 root->add_child("NotificationFrom")->add_child_text (_notification_from);
738 /* [XML] NotificationFrom To address to use for notification emails. */
739 root->add_child("NotificationTo")->add_child_text (_notification_to);
740 for (auto i: _notification_cc) {
741 /* [XML] NotificationCC CC address to use for notification emails; you can use as many of these tags as you like. */
742 root->add_child("NotificationCC")->add_child_text (i);
744 /* [XML] NotificationBCC BCC address to use for notification emails. */
745 root->add_child("NotificationBCC")->add_child_text (_notification_bcc);
746 /* [XML] NotificationEmail Text of notification email. */
747 root->add_child("NotificationEmail")->add_child_text (_notification_email);
749 /* [XML] CheckForUpdates 1 to check dcpomatic.com for new versions, 0 to check only on request. */
750 root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
751 /* [XML] CheckForUpdates 1 to check dcpomatic.com for new text versions, 0 to check only on request. */
752 root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
754 /* [XML] MaximumJ2KBandwidth Maximum J2K bandwidth (in bits per second) that can be specified in the GUI. */
755 root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
756 /* [XML] AllowAnyDCPFrameRate 1 to allow users to specify any frame rate when creating DCPs, 0 to limit the GUI to standard rates. */
757 root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
758 /* [XML] AllowAnyContainer 1 to allow users to user any container ratio for their DCP, 0 to limit the GUI to DCI Flat/Scope */
759 root->add_child("AllowAnyContainer")->add_child_text (_allow_any_container ? "1" : "0");
760 /* [XML] ShowExperimentalAudioProcessors 1 to offer users the (experimental) audio upmixer processors, 0 to hide them */
761 root->add_child("ShowExperimentalAudioProcessors")->add_child_text (_show_experimental_audio_processors ? "1" : "0");
762 /* [XML] LogTypes Types of logging to write; a bitfield where 1 is general notes, 2 warnings, 4 errors, 8 debug information related
763 to 3D, 16 debug information related to encoding, 32 debug information for timing purposes, 64 debug information related
764 to sending email, 128 debug information related to the video view, 256 information about disk writing, 512 debug information
765 related to the player, 1024 debug information related to audio analyses.
767 root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
768 /* [XML] AnalyseEBUR128 1 to do EBUR128 analyses when analysing audio, otherwise 0. */
769 root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
770 /* [XML] AutomaticAudioAnalysis 1 to run audio analysis automatically when audio content is added to the film, otherwise 0. */
771 root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
772 #ifdef DCPOMATIC_WINDOWS
773 if (_win32_console) {
774 /* [XML] Win32Console 1 to open a console when running on Windows, otherwise 0.
775 * We only write this if it's true, which is a bit of a hack to allow unit tests to work
776 * more easily on Windows (without a platform-specific reference in config_write_utf8_test)
778 root->add_child("Win32Console")->add_child_text ("1");
782 /* [XML] Signer Certificate chain and private key to use when signing DCPs and KDMs. Should contain <code><Certificate></code>
783 tags in order and a <code><PrivateKey></code> tag all containing PEM-encoded certificates or private keys as appropriate.
785 auto signer = root->add_child ("Signer");
786 DCPOMATIC_ASSERT (_signer_chain);
787 for (auto const& i: _signer_chain->unordered()) {
788 signer->add_child("Certificate")->add_child_text (i.certificate (true));
790 signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
792 /* [XML] Decryption Certificate chain and private key to use when decrypting KDMs */
793 auto decryption = root->add_child ("Decryption");
794 DCPOMATIC_ASSERT (_decryption_chain);
795 for (auto const& i: _decryption_chain->unordered()) {
796 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
798 decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
800 /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the GUI; there can be more than one
803 for (auto i: _history) {
804 root->add_child("History")->add_child_text (i.string ());
807 /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the player; there can be more than one
810 for (auto i: _player_history) {
811 root->add_child("PlayerHistory")->add_child_text (i.string ());
814 /* [XML] DKDMGroup A group of DKDMs, each with a <code>Name</code> attribute, containing other <code><DKDMGroup></code>
815 or <code><DKDM></code> tags.
817 /* [XML] DKDM A DKDM as XML */
818 _dkdms->as_xml (root);
820 /* [XML] CinemasFile Filename of cinemas list file. */
821 root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
822 /* [XML] DKDMRecipientsFile Filename of DKDM recipients list file. */
823 root->add_child("DKDMRecipientsFile")->add_child_text (_dkdm_recipients_file.string());
824 /* [XML] ShowHintsBeforeMakeDCP 1 to show hints in the GUI before making a DCP, otherwise 0. */
825 root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
826 /* [XML] ConfirmKDMEmail 1 to confirm before sending KDM emails in the GUI, otherwise 0. */
827 root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0");
828 /* [XML] KDMFilenameFormat Format for KDM filenames. */
829 root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
830 /* [XML] KDMFilenameFormat Format for DKDM filenames. */
831 root->add_child("DKDMFilenameFormat")->add_child_text(_dkdm_filename_format.specification());
832 /* [XML] KDMContainerNameFormat Format for KDM containers (directories or ZIP files). */
833 root->add_child("KDMContainerNameFormat")->add_child_text (_kdm_container_name_format.specification ());
834 /* [XML] DCPMetadataFilenameFormat Format for DCP metadata filenames. */
835 root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ());
836 /* [XML] DCPAssetFilenameFormat Format for DCP asset filenames. */
837 root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ());
838 /* [XML] JumpToSelected 1 to make the GUI jump to the start of content when it is selected, otherwise 0. */
839 root->add_child("JumpToSelected")->add_child_text (_jump_to_selected ? "1" : "0");
840 /* [XML] Nagged 1 if a particular nag screen has been shown and should not be shown again, otherwise 0. */
841 for (int i = 0; i < NAG_COUNT; ++i) {
842 xmlpp::Element* e = root->add_child ("Nagged");
843 e->set_attribute ("Id", raw_convert<string>(i));
844 e->add_child_text (_nagged[i] ? "1" : "0");
846 /* [XML] PreviewSound 1 to use sound in the GUI preview and player, otherwise 0. */
847 root->add_child("PreviewSound")->add_child_text (_sound ? "1" : "0");
849 /* [XML:opt] PreviewSoundOutput Name of the audio output to use. */
850 root->add_child("PreviewSoundOutput")->add_child_text (_sound_output.get());
852 /* [XML] CoverSheet Text of the cover sheet to write when making DCPs. */
853 root->add_child("CoverSheet")->add_child_text (_cover_sheet);
854 if (_last_player_load_directory) {
855 root->add_child("LastPlayerLoadDirectory")->add_child_text(_last_player_load_directory->string());
857 /* [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. */
858 if (_last_kdm_write_type) {
859 switch (_last_kdm_write_type.get()) {
861 root->add_child("LastKDMWriteType")->add_child_text("flat");
863 case KDM_WRITE_FOLDER:
864 root->add_child("LastKDMWriteType")->add_child_text("folder");
867 root->add_child("LastKDMWriteType")->add_child_text("zip");
871 /* [XML] LastDKDMWriteType Last type of DKDM-write: <code>file</code> for a file, <code>internal</code> to add to DCP-o-matic's list. */
872 if (_last_dkdm_write_type) {
873 switch (_last_dkdm_write_type.get()) {
874 case DKDM_WRITE_INTERNAL:
875 root->add_child("LastDKDMWriteType")->add_child_text("internal");
877 case DKDM_WRITE_FILE:
878 root->add_child("LastDKDMWriteType")->add_child_text("file");
882 /* [XML] FramesInMemoryMultiplier value to multiply the encoding threads count by to get the maximum number of
883 frames to be held in memory at once.
885 root->add_child("FramesInMemoryMultiplier")->add_child_text(raw_convert<string>(_frames_in_memory_multiplier));
887 /* [XML] DecodeReduction power of 2 to reduce DCP images by before decoding in the player. */
888 if (_decode_reduction) {
889 root->add_child("DecodeReduction")->add_child_text(raw_convert<string>(_decode_reduction.get()));
892 /* [XML] DefaultNotify 1 to default jobs to notify when complete, otherwise 0. */
893 root->add_child("DefaultNotify")->add_child_text(_default_notify ? "1" : "0");
895 /* [XML] Notification 1 if a notification type is enabled, otherwise 0. */
896 for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
897 xmlpp::Element* e = root->add_child ("Notification");
898 e->set_attribute ("Id", raw_convert<string>(i));
899 e->add_child_text (_notification[i] ? "1" : "0");
902 if (_barco_username) {
903 /* [XML] BarcoUsername Username for logging into Barco's servers when downloading server certificates. */
904 root->add_child("BarcoUsername")->add_child_text(*_barco_username);
906 if (_barco_password) {
907 /* [XML] BarcoPassword Password for logging into Barco's servers when downloading server certificates. */
908 root->add_child("BarcoPassword")->add_child_text(*_barco_password);
911 if (_christie_username) {
912 /* [XML] ChristieUsername Username for logging into Christie's servers when downloading server certificates. */
913 root->add_child("ChristieUsername")->add_child_text(*_christie_username);
915 if (_christie_password) {
916 /* [XML] ChristiePassword Password for logging into Christie's servers when downloading server certificates. */
917 root->add_child("ChristiePassword")->add_child_text(*_christie_password);
921 /* [XML] GDCUsername Username for logging into GDC's servers when downloading server certificates. */
922 root->add_child("GDCUsername")->add_child_text(*_gdc_username);
925 /* [XML] GDCPassword Password for logging into GDC's servers when downloading server certificates. */
926 root->add_child("GDCPassword")->add_child_text(*_gdc_password);
929 /* [XML] PlayerMode <code>window</code> for a single window, <code>full</code> for full-screen and <code>dual</code> for full screen playback
930 with controls on another monitor.
932 switch (_player_mode) {
933 case PLAYER_MODE_WINDOW:
934 root->add_child("PlayerMode")->add_child_text("window");
936 case PLAYER_MODE_FULL:
937 root->add_child("PlayerMode")->add_child_text("full");
939 case PLAYER_MODE_DUAL:
940 root->add_child("PlayerMode")->add_child_text("dual");
944 /* [XML] ImageDisplay Screen number to put image on in dual-screen player mode. */
945 root->add_child("ImageDisplay")->add_child_text(raw_convert<string>(_image_display));
946 switch (_video_view_type) {
947 case VIDEO_VIEW_SIMPLE:
948 root->add_child("VideoViewType")->add_child_text("simple");
950 case VIDEO_VIEW_OPENGL:
951 root->add_child("VideoViewType")->add_child_text("opengl");
954 /* [XML] RespectKDMValidityPeriods 1 to refuse to use KDMs that are out of date, 0 to ignore KDM dates. */
955 root->add_child("RespectKDMValidityPeriods")->add_child_text(_respect_kdm_validity_periods ? "1" : "0");
956 if (_player_activity_log_file) {
957 /* [XML] PlayerLogFile Filename to use for player activity logs (e.g starting, stopping, playlist loads) */
958 root->add_child("PlayerActivityLogFile")->add_child_text(_player_activity_log_file->string());
960 if (_player_debug_log_file) {
961 /* [XML] PlayerLogFile Filename to use for player debug logs */
962 root->add_child("PlayerDebugLogFile")->add_child_text(_player_debug_log_file->string());
964 if (_player_content_directory) {
965 /* [XML] PlayerContentDirectory Directory to use for player content in the dual-screen mode. */
966 root->add_child("PlayerContentDirectory")->add_child_text(_player_content_directory->string());
968 if (_player_playlist_directory) {
969 /* [XML] PlayerPlaylistDirectory Directory to use for player playlists in the dual-screen mode. */
970 root->add_child("PlayerPlaylistDirectory")->add_child_text(_player_playlist_directory->string());
972 if (_player_kdm_directory) {
973 /* [XML] PlayerKDMDirectory Directory to use for player KDMs in the dual-screen mode. */
974 root->add_child("PlayerKDMDirectory")->add_child_text(_player_kdm_directory->string());
976 if (_audio_mapping) {
977 _audio_mapping->as_xml (root->add_child("AudioMapping"));
979 root->add_child("MinimumFrameSize")->add_child_text(raw_convert<string>(_minimum_frame_size));
980 for (auto const& i: _custom_languages) {
981 root->add_child("CustomLanguage")->add_child_text(i.to_string());
985 auto const s = doc.write_to_string_formatted ();
986 boost::filesystem::path tmp (string(config_file().string()).append(".tmp"));
987 auto f = fopen_boost (tmp, "w");
989 throw FileError (_("Could not open file for writing"), tmp);
991 checked_fwrite (s.c_str(), s.bytes(), f, tmp);
993 boost::filesystem::remove (config_file());
994 boost::filesystem::rename (tmp, config_file());
995 } catch (xmlpp::exception& e) {
996 string s = e.what ();
998 throw FileError (s, config_file());
1005 write_file (string root_node, string node, string version, list<shared_ptr<T>> things, boost::filesystem::path file)
1007 xmlpp::Document doc;
1008 auto root = doc.create_root_node (root_node);
1009 root->add_child("Version")->add_child_text(version);
1011 for (auto i: things) {
1012 i->as_xml (root->add_child(node));
1016 doc.write_to_file_formatted (file.string() + ".tmp");
1017 boost::filesystem::remove (file);
1018 boost::filesystem::rename (file.string() + ".tmp", file);
1019 } catch (xmlpp::exception& e) {
1020 string s = e.what ();
1022 throw FileError (s, file);
1028 Config::write_cinemas () const
1030 write_file ("Cinemas", "Cinema", "1", _cinemas, _cinemas_file);
1035 Config::write_dkdm_recipients () const
1037 write_file ("DKDMRecipients", "DKDMRecipient", "1", _dkdm_recipients, _dkdm_recipients_file);
1041 boost::filesystem::path
1042 Config::default_directory_or (boost::filesystem::path a) const
1044 return directory_or (_default_directory, a);
1047 boost::filesystem::path
1048 Config::default_kdm_directory_or (boost::filesystem::path a) const
1050 return directory_or (_default_kdm_directory, a);
1053 boost::filesystem::path
1054 Config::directory_or (optional<boost::filesystem::path> dir, boost::filesystem::path a) const
1060 boost::system::error_code ec;
1061 auto const e = boost::filesystem::exists (*dir, ec);
1077 Config::changed (Property what)
1083 Config::set_kdm_email_to_default ()
1085 _kdm_subject = _("KDM delivery: $CPL_NAME");
1088 "Dear Projectionist\n\n"
1089 "Please find attached KDMs for $CPL_NAME.\n\n"
1090 "Cinema: $CINEMA_NAME\n"
1091 "Screen(s): $SCREENS\n\n"
1092 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
1093 "Best regards,\nDCP-o-matic"
1098 Config::set_notification_email_to_default ()
1100 _notification_subject = _("DCP-o-matic notification");
1102 _notification_email = _(
1103 "$JOB_NAME: $JOB_STATUS"
1108 Config::reset_kdm_email ()
1110 set_kdm_email_to_default ();
1115 Config::reset_notification_email ()
1117 set_notification_email_to_default ();
1122 Config::set_cover_sheet_to_default ()
1127 "Format: $CONTAINER\n"
1129 "Audio Language: $AUDIO_LANGUAGE\n"
1130 "Subtitle Language: $SUBTITLE_LANGUAGE\n"
1137 Config::add_to_history (boost::filesystem::path p)
1139 add_to_history_internal (_history, p);
1142 /** Remove non-existant items from the history */
1144 Config::clean_history ()
1146 clean_history_internal (_history);
1150 Config::add_to_player_history (boost::filesystem::path p)
1152 add_to_history_internal (_player_history, p);
1155 /** Remove non-existant items from the player history */
1157 Config::clean_player_history ()
1159 clean_history_internal (_player_history);
1163 Config::add_to_history_internal (vector<boost::filesystem::path>& h, boost::filesystem::path p)
1165 /* Remove existing instances of this path in the history */
1166 h.erase (remove (h.begin(), h.end(), p), h.end ());
1168 h.insert (h.begin (), p);
1169 if (h.size() > HISTORY_SIZE) {
1177 Config::clean_history_internal (vector<boost::filesystem::path>& h)
1183 if (boost::filesystem::is_directory(i)) {
1187 /* We couldn't find out if it's a directory for some reason; just ignore it */
1193 Config::have_existing (string file)
1195 return boost::filesystem::exists (path (file, false));
1199 Config::read_cinemas (cxml::Document const & f)
1202 for (auto i: f.node_children("Cinema")) {
1203 /* Slightly grotty two-part construction of Cinema here so that we can use
1206 auto cinema = make_shared<Cinema>(i);
1207 cinema->read_screens (i);
1208 _cinemas.push_back (cinema);
1213 Config::set_cinemas_file (boost::filesystem::path file)
1215 if (file == _cinemas_file) {
1219 _cinemas_file = file;
1221 if (boost::filesystem::exists (_cinemas_file)) {
1222 /* Existing file; read it in */
1223 cxml::Document f ("Cinemas");
1224 f.read_file (_cinemas_file);
1233 Config::read_dkdm_recipients (cxml::Document const & f)
1235 _dkdm_recipients.clear ();
1236 for (auto i: f.node_children("DKDMRecipient")) {
1237 _dkdm_recipients.push_back (shared_ptr<DKDMRecipient>(new DKDMRecipient(i)));
1242 Config::set_dkdm_recipients_file (boost::filesystem::path file)
1244 if (file == _dkdm_recipients_file) {
1248 _dkdm_recipients_file = file;
1250 if (boost::filesystem::exists (_dkdm_recipients_file)) {
1251 /* Existing file; read it in */
1252 cxml::Document f ("DKDMRecipients");
1253 f.read_file (_dkdm_recipients_file);
1254 read_dkdm_recipients (f);
1262 Config::save_template (shared_ptr<const Film> film, string name) const
1264 film->write_template (template_path (name));
1268 Config::templates () const
1270 if (!boost::filesystem::exists (path ("templates"))) {
1275 for (auto const& i: boost::filesystem::directory_iterator(path("templates"))) {
1276 n.push_back (i.path().filename().string());
1282 Config::existing_template (string name) const
1284 return boost::filesystem::exists (template_path (name));
1287 boost::filesystem::path
1288 Config::template_path (string name) const
1290 return path("templates") / tidy_for_filename (name);
1294 Config::rename_template (string old_name, string new_name) const
1296 boost::filesystem::rename (template_path (old_name), template_path (new_name));
1300 Config::delete_template (string name) const
1302 boost::filesystem::remove (template_path (name));
1305 /** @return Path to the config.xml containing the actual settings, following a link if required */
1306 boost::filesystem::path
1307 Config::config_file ()
1309 cxml::Document f ("Config");
1310 auto main = path("config.xml", false);
1311 if (!boost::filesystem::exists (main)) {
1312 /* It doesn't exist, so there can't be any links; just return it */
1316 /* See if there's a link */
1319 auto link = f.optional_string_child("Link");
1323 } catch (xmlpp::exception& e) {
1324 /* There as a problem reading the main configuration file,
1325 so there can't be a link.
1333 Config::reset_cover_sheet ()
1335 set_cover_sheet_to_default ();
1340 Config::link (boost::filesystem::path new_file) const
1342 xmlpp::Document doc;
1343 doc.create_root_node("Config")->add_child("Link")->add_child_text(new_file.string());
1345 doc.write_to_file_formatted(path("config.xml", true).string());
1346 } catch (xmlpp::exception& e) {
1347 string s = e.what ();
1349 throw FileError (s, path("config.xml"));
1354 Config::copy_and_link (boost::filesystem::path new_file) const
1357 boost::filesystem::copy_file (config_file(), new_file, boost::filesystem::copy_option::overwrite_if_exists);
1362 Config::have_write_permission () const
1364 auto f = fopen_boost (config_file(), "r+");
1373 /** @param output_channels Number of output channels in use.
1374 * @return Audio mapping for this output channel count (may be a default).
1377 Config::audio_mapping (int output_channels)
1379 if (!_audio_mapping || _audio_mapping->output_channels() != output_channels) {
1380 /* Set up a default */
1381 _audio_mapping = AudioMapping (MAX_DCP_AUDIO_CHANNELS, output_channels);
1382 if (output_channels == 2) {
1383 /* Special case for stereo output.
1384 Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
1385 Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
1387 _audio_mapping->set (dcp::Channel::LEFT, 0, 1 / sqrt(2)); // L -> Lt
1388 _audio_mapping->set (dcp::Channel::RIGHT, 1, 1 / sqrt(2)); // R -> Rt
1389 _audio_mapping->set (dcp::Channel::CENTRE, 0, 1 / 2.0); // C -> Lt
1390 _audio_mapping->set (dcp::Channel::CENTRE, 1, 1 / 2.0); // C -> Rt
1391 _audio_mapping->set (dcp::Channel::LFE, 0, 1 / sqrt(10)); // Lfe -> Lt
1392 _audio_mapping->set (dcp::Channel::LFE, 1, 1 / sqrt(10)); // Lfe -> Rt
1393 _audio_mapping->set (dcp::Channel::LS, 0, 1 / sqrt(2)); // Ls -> Lt
1394 _audio_mapping->set (dcp::Channel::RS, 1, 1 / sqrt(2)); // Rs -> Rt
1397 for (int i = 0; i < min (MAX_DCP_AUDIO_CHANNELS, output_channels); ++i) {
1398 _audio_mapping->set (i, i, 1);
1403 return *_audio_mapping;
1407 Config::set_audio_mapping (AudioMapping m)
1410 changed (AUDIO_MAPPING);
1414 Config::set_audio_mapping_to_default ()
1416 DCPOMATIC_ASSERT (_audio_mapping);
1417 auto const ch = _audio_mapping->output_channels ();
1418 _audio_mapping = boost::none;
1419 _audio_mapping = audio_mapping (ch);
1420 changed (AUDIO_MAPPING);
1425 Config::add_custom_language (dcp::LanguageTag tag)
1427 if (find(_custom_languages.begin(), _custom_languages.end(), tag) == _custom_languages.end()) {
1428 _custom_languages.push_back (tag);