2 Copyright (C) 2012-2018 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 "cinema_sound_processor.h"
28 #include "colour_conversion.h"
33 #include "dkdm_wrapper.h"
34 #include "compose.hpp"
35 #include <dcp/raw_convert.h>
36 #include <dcp/name_format.h>
37 #include <dcp/certificate_chain.h>
38 #include <libcxml/cxml.h>
40 #include <libxml++/libxml++.h>
41 #include <boost/filesystem.hpp>
42 #include <boost/algorithm/string.hpp>
43 #include <boost/foreach.hpp>
44 #include <boost/thread.hpp>
60 using boost::shared_ptr;
61 using boost::optional;
62 using boost::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 (void)> Config::BadSignerChain;
71 boost::optional<boost::filesystem::path> Config::override_path;
73 /** Construct default configuration */
75 /* DKDMs are not considered a thing to reset on set_defaults() */
76 : _dkdms (new DKDMGroup ("root"))
82 Config::set_defaults ()
84 _master_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
85 _server_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
86 _server_port_base = 6192;
87 _use_any_servers = true;
89 _only_servers_encode = false;
90 _tms_protocol = PROTOCOL_SCP;
95 _cinema_sound_processor = CinemaSoundProcessor::from_id (N_("dolby_cp750"));
96 _allow_any_dcp_frame_rate = false;
97 _language = optional<string> ();
98 _default_still_length = 10;
99 _default_container = Ratio::from_id ("185");
100 _default_scale_to = 0;
101 _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
102 _default_dcp_audio_channels = 6;
103 _default_j2k_bandwidth = 100000000;
104 _default_audio_delay = 0;
105 _default_interop = true;
106 _default_upload_after_make_dcp = false;
114 _check_for_updates = false;
115 _check_for_test_updates = false;
116 _maximum_j2k_bandwidth = 250000000;
117 _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR;
118 _analyse_ebur128 = true;
119 _automatic_audio_analysis = false;
120 #ifdef DCPOMATIC_WINDOWS
121 _win32_console = false;
123 _cinemas_file = path ("cinemas.xml");
124 _show_hints_before_make_dcp = true;
125 _confirm_kdm_email = true;
126 _kdm_container_name_format = dcp::NameFormat ("KDM %f %c");
127 _kdm_filename_format = dcp::NameFormat ("KDM %f %c %s");
128 _dcp_metadata_filename_format = dcp::NameFormat ("%t");
129 _dcp_asset_filename_format = dcp::NameFormat ("%t");
130 _jump_to_selected = true;
131 for (int i = 0; i < NAG_COUNT; ++i) {
135 _sound_output = optional<string> ();
136 _last_kdm_write_type = KDM_WRITE_FLAT;
137 _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
139 /* I think the scaling factor here should be the ratio of the longest frame
140 encode time to the shortest; if the thread count is T, longest time is L
141 and the shortest time S we could encode L/S frames per thread whilst waiting
142 for the L frame to encode so we might have to store LT/S frames.
144 However we don't want to use too much memory, so keep it a bit lower than we'd
145 perhaps like. A J2K frame is typically about 1Mb so 3 here will mean we could
146 use about 240Mb with 72 encoding threads.
148 _frames_in_memory_multiplier = 3;
149 _decode_reduction = optional<int>();
151 _allowed_dcp_frame_rates.clear ();
152 _allowed_dcp_frame_rates.push_back (24);
153 _allowed_dcp_frame_rates.push_back (25);
154 _allowed_dcp_frame_rates.push_back (30);
155 _allowed_dcp_frame_rates.push_back (48);
156 _allowed_dcp_frame_rates.push_back (50);
157 _allowed_dcp_frame_rates.push_back (60);
159 set_kdm_email_to_default ();
160 set_cover_sheet_to_default ();
164 Config::restore_defaults ()
166 Config::instance()->set_defaults ();
167 Config::instance()->changed ();
170 shared_ptr<dcp::CertificateChain>
171 Config::create_certificate_chain ()
173 return shared_ptr<dcp::CertificateChain> (
174 new dcp::CertificateChain (
178 ".dcpomatic.smpte-430-2.ROOT",
179 ".dcpomatic.smpte-430-2.INTERMEDIATE",
180 "CS.dcpomatic.smpte-430-2.LEAF"
188 /* Make a copy of the configuration */
191 while (n < 100 && boost::filesystem::exists(path(String::compose("config.xml.%1", n)))) {
195 boost::filesystem::copy_file(path("config.xml", false), path(String::compose("config.xml.%1", n), false));
196 boost::filesystem::copy_file(path("cinemas.xml", false), path(String::compose("cinemas.xml.%1", n), false));
204 cxml::Document f ("Config");
205 f.read_file (config_file ());
207 optional<int> version = f.optional_number_child<int> ("Version");
208 if (version && *version < _current_version) {
209 /* Back up the old config before we re-write it in a back-incompatible way */
213 if (f.optional_number_child<int>("NumLocalEncodingThreads")) {
214 _master_encoding_threads = _server_encoding_threads = f.optional_number_child<int>("NumLocalEncodingThreads").get();
216 _master_encoding_threads = f.number_child<int>("MasterEncodingThreads");
217 _server_encoding_threads = f.number_child<int>("ServerEncodingThreads");
220 _default_directory = f.optional_string_child ("DefaultDirectory");
221 if (_default_directory && _default_directory->empty ()) {
222 /* We used to store an empty value for this to mean "none set" */
223 _default_directory = boost::optional<boost::filesystem::path> ();
226 boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
228 b = f.optional_number_child<int> ("ServerPortBase");
230 _server_port_base = b.get ();
232 boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
233 _use_any_servers = u.get_value_or (true);
235 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Server")) {
236 if (i->node_children("HostName").size() == 1) {
237 _servers.push_back (i->string_child ("HostName"));
239 _servers.push_back (i->content ());
243 _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
244 _tms_protocol = static_cast<Protocol> (f.optional_number_child<int> ("TMSProtocol").get_value_or (static_cast<int> (PROTOCOL_SCP)));
245 _tms_ip = f.string_child ("TMSIP");
246 _tms_path = f.string_child ("TMSPath");
247 _tms_user = f.string_child ("TMSUser");
248 _tms_password = f.string_child ("TMSPassword");
251 c = f.optional_string_child ("SoundProcessor");
253 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
255 c = f.optional_string_child ("CinemaSoundProcessor");
257 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
260 _language = f.optional_string_child ("Language");
262 c = f.optional_string_child ("DefaultContainer");
264 _default_container = Ratio::from_id (c.get ());
267 if (_default_container && !_default_container->used_for_container()) {
268 Warning (_("Your default container is not valid and has been changed to Flat (1.85:1)"));
269 _default_container = Ratio::from_id ("185");
272 c = f.optional_string_child ("DefaultScaleTo");
274 _default_scale_to = Ratio::from_id (c.get ());
277 _default_dcp_content_type = DCPContentType::from_isdcf_name(f.optional_string_child("DefaultDCPContentType").get_value_or("FTR"));
278 _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
280 if (f.optional_string_child ("DCPMetadataIssuer")) {
281 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
282 } else if (f.optional_string_child ("DCPIssuer")) {
283 _dcp_issuer = f.string_child ("DCPIssuer");
286 _default_upload_after_make_dcp = f.optional_bool_child("DefaultUploadAfterMakeDCP").get_value_or (false);
287 _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
289 if (version && version.get() >= 2) {
290 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
292 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
295 _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
296 _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
297 _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
298 _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
299 _default_kdm_directory = f.optional_string_child("DefaultKDMDirectory");
301 /* Load any cinemas from config.xml */
304 _mail_server = f.string_child ("MailServer");
305 _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
306 _mail_user = f.optional_string_child("MailUser").get_value_or ("");
307 _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
308 _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
309 _kdm_from = f.string_child ("KDMFrom");
310 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("KDMCC")) {
311 if (!i->content().empty()) {
312 _kdm_cc.push_back (i->content ());
315 _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
316 _kdm_email = f.string_child ("KDMEmail");
318 _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
319 _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
321 _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
322 _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
324 _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
325 _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
326 _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
327 #ifdef DCPOMATIC_WINDOWS
328 _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
331 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("History")) {
332 _history.push_back (i->content ());
335 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("PlayerHistory")) {
336 _player_history.push_back (i->content ());
339 cxml::NodePtr signer = f.optional_node_child ("Signer");
341 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
342 /* Read the signing certificates and private key in from the config file */
343 BOOST_FOREACH (cxml::NodePtr i, signer->node_children ("Certificate")) {
344 c->add (dcp::Certificate (i->content ()));
346 c->set_key (signer->string_child ("PrivateKey"));
349 /* Make a new set of signing certificates and key */
350 _signer_chain = create_certificate_chain ();
353 /* These must be done before we call BadSignerChain as that might set one
356 BOOST_FOREACH (cxml::NodePtr i, f.node_children("Nagged")) {
357 int const id = i->number_attribute<int>("Id");
358 if (id >= 0 && id < NAG_COUNT) {
359 _nagged[id] = raw_convert<int>(i->content());
363 bool bad_signer_chain = false;
364 BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->unordered()) {
365 if (i.has_utf8_strings()) {
366 bad_signer_chain = true;
370 if (bad_signer_chain) {
371 optional<bool> const remake = BadSignerChain();
372 if (remake && *remake) {
373 _signer_chain = create_certificate_chain ();
377 cxml::NodePtr decryption = f.optional_node_child ("Decryption");
379 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
380 BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) {
381 c->add (dcp::Certificate (i->content ()));
383 c->set_key (decryption->string_child ("PrivateKey"));
384 _decryption_chain = c;
386 _decryption_chain = create_certificate_chain ();
389 if (f.optional_node_child("DKDMGroup")) {
390 /* New-style: all DKDMs in a group */
391 _dkdms = dynamic_pointer_cast<DKDMGroup> (DKDMBase::read (f.node_child("DKDMGroup")));
393 /* Old-style: one or more DKDM nodes */
394 _dkdms.reset (new DKDMGroup ("root"));
395 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("DKDM")) {
396 _dkdms->add (DKDMBase::read (i));
399 _cinemas_file = f.optional_string_child("CinemasFile").get_value_or (path ("cinemas.xml").string ());
400 _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
401 _confirm_kdm_email = f.optional_bool_child("ConfirmKDMEmail").get_value_or (true);
402 _kdm_container_name_format = dcp::NameFormat (f.optional_string_child("KDMContainerNameFormat").get_value_or ("KDM %f %c"));
403 _kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
404 _dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t"));
405 _dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t"));
406 _jump_to_selected = f.optional_bool_child("JumpToSelected").get_value_or (true);
407 /* The variable was renamed but not the XML tag */
408 _sound = f.optional_bool_child("PreviewSound").get_value_or (true);
409 _sound_output = f.optional_string_child("PreviewSoundOutput");
410 if (f.optional_string_child("CoverSheet")) {
411 _cover_sheet = f.optional_string_child("CoverSheet").get();
413 _last_player_load_directory = f.optional_string_child("LastPlayerLoadDirectory");
414 if (f.optional_string_child("LastKDMWriteType")) {
415 if (f.optional_string_child("LastKDMWriteType").get() == "flat") {
416 _last_kdm_write_type = KDM_WRITE_FLAT;
417 } else if (f.optional_string_child("LastKDMWriteType").get() == "folder") {
418 _last_kdm_write_type = KDM_WRITE_FOLDER;
419 } else if (f.optional_string_child("LastKDMWriteType").get() == "zip") {
420 _last_kdm_write_type = KDM_WRITE_ZIP;
423 if (f.optional_string_child("LastDKDMWriteType")) {
424 if (f.optional_string_child("LastDKDMWriteType").get() == "internal") {
425 _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
426 } else if (f.optional_string_child("LastDKDMWriteType").get() == "file") {
427 _last_dkdm_write_type = DKDM_WRITE_FILE;
430 _frames_in_memory_multiplier = f.optional_number_child<int>("FramesInMemoryMultiplier").get_value_or(3);
431 _decode_reduction = f.optional_number_child<int>("DecodeReduction");
433 /* Replace any cinemas from config.xml with those from the configured file */
434 if (boost::filesystem::exists (_cinemas_file)) {
435 cxml::Document f ("Cinemas");
436 f.read_file (_cinemas_file);
441 if (have_existing ("config.xml")) {
443 /* We have a config file but it didn't load */
447 /* Make a new set of signing certificates and key */
448 _signer_chain = create_certificate_chain ();
449 /* And similar for decryption of KDMs */
450 _decryption_chain = create_certificate_chain ();
454 /** @return Filename to write configuration to */
455 boost::filesystem::path
456 Config::path (string file, bool create_directories)
458 boost::filesystem::path p;
463 p /= g_get_home_dir ();
466 p /= "com.dcpomatic";
469 p /= g_get_user_config_dir ();
473 boost::system::error_code ec;
474 if (create_directories) {
475 boost::filesystem::create_directories (p, ec);
481 /** @return Singleton instance */
485 if (_instance == 0) {
486 _instance = new Config;
493 /** Write our configuration to disk */
495 Config::write () const
502 Config::write_config () const
505 xmlpp::Element* root = doc.create_root_node ("Config");
507 /* [XML] Version The version number of the configuration file format */
508 root->add_child("Version")->add_child_text (String::compose ("%1", _current_version));
509 /* [XML] MasterEncodingThreads Number of encoding threads to use when running as master. */
510 root->add_child("MasterEncodingThreads")->add_child_text (raw_convert<string> (_master_encoding_threads));
511 /* [XML] ServerEncodingThreads Number of encoding threads to use when running as server. */
512 root->add_child("ServerEncodingThreads")->add_child_text (raw_convert<string> (_server_encoding_threads));
513 if (_default_directory) {
514 /* [XML:opt] DefaultDirectory Default directory when creating a new film in the GUI. */
515 root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ());
517 /* [XML] ServerPortBase Port number to use for frame encoding requests. <code>ServerPortBase</code> + 1 and
518 <code>ServerPortBase</code> + 2 are used for querying servers. <code>ServerPortBase</code> + 3 is used
519 by the batch converter to listen for job requests.
521 root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
522 /* [XML] UseAnyServers 1 to broadcast to look for encoding servers to use, 0 to use only those configured. */
523 root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
525 BOOST_FOREACH (string i, _servers) {
526 /* [XML:opt] Server IP address or hostname of an encoding server to use; you can use as many of these tags
529 root->add_child("Server")->add_child_text (i);
532 /* [XML] OnlyServersEncode 1 to set the master to do decoding of source content no JPEG2000 encoding; all encoding
533 is done by the encoding servers. 0 to set the master to do some encoding as well as coordinating the job.
535 root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
536 /* [XML] TMSProtocol Protocol to use to copy files to a TMS; 0 to use SCP, 1 for FTP. */
537 root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
538 /* [XML] TMSIP IP address of TMS */
539 root->add_child("TMSIP")->add_child_text (_tms_ip);
540 /* [XML] TMSPath Path on the TMS to copy files to */
541 root->add_child("TMSPath")->add_child_text (_tms_path);
542 /* [XML] TMSUser Username to log into the TMS with */
543 root->add_child("TMSUser")->add_child_text (_tms_user);
544 /* [XML] TMSPassword Password to log into the TMS with */
545 root->add_child("TMSPassword")->add_child_text (_tms_password);
546 if (_cinema_sound_processor) {
547 /* [XML:opt] CinemaSoundProcessor Identifier of the type of cinema sound processor to use when calculating
548 gain changes from fader positions. Currently can only be <code>dolby_cp750</code>.
550 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
553 /* [XML:opt] Language Language to use in the GUI e.g. <code>fr_FR</code>. */
554 root->add_child("Language")->add_child_text (_language.get());
556 if (_default_container) {
557 /* [XML:opt] DefaultContainer ID of default container
558 * to use when creating new films (<code>185</code>,<code>239</code> or
561 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
563 if (_default_scale_to) {
564 /* [XML:opt] DefaultScaleTo ID of default ratio to scale content to when creating new films
565 (see <code>DefaultContainer</code> for IDs).
567 root->add_child("DefaultScaleTo")->add_child_text (_default_scale_to->id ());
569 if (_default_dcp_content_type) {
570 /* [XML:opt] DefaultDCPContentType Default content type ot use when creating new films (<code>FTR</code>, <code>SHR</code>,
571 <code>TLR</code>, <code>TST</code>, <code>XSN</code>, <code>RTG</code>, <code>TSR</code>, <code>POL</code>,
572 <code>PSA</code> or <code>ADV</code>). */
573 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
575 /* [XML] DefaultDCPAudioChannels Default number of audio channels to use when creating new films. */
576 root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
577 /* [XML] DCPIssuer Issuer text to write into CPL files. */
578 root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
579 /* [XML] DCPIssuer Creator text to write into CPL files. */
580 root->add_child("DCPCreator")->add_child_text (_dcp_creator);
581 root->add_child("DefaultUploadAfterMakeDCP")->add_child_text (_default_upload_after_make_dcp ? "1" : "0");
583 /* [XML] ISDCFMetadata Default ISDCF metadata to use for new films; child tags are <code><ContentVersion></code>,
584 <code><AudioLanguage></code>, <code><SubtitleLanguage></code>, <code><Territory></code>,
585 <code><Rating></code>, <code><Studio></code>, <code><Facility></code>, <code><TempVersion></code>,
586 <code><PreRelease></code>, <code><RedBand></code>, <code><Chain></code>, <code><TwoDVersionOFThreeD></code>,
587 <code><MasteredLuminance></code>.
589 _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
591 /* [XML] DefaultStillLength Default length (in seconds) for still images in new films. */
592 root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
593 /* [XML] DefaultJ2KBandwidth Default bitrate (in bits per second) for JPEG2000 data in new films. */
594 root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
595 /* [XML] DefaultAudioDelay Default delay to apply to audio (positive moves audio later) in milliseconds. */
596 root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
597 /* [XML] DefaultInterop 1 to default new films to Interop, 0 for SMPTE. */
598 root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
599 if (_default_kdm_directory) {
600 /* [XML:opt] DefaultKDMDirectory Default directory to write KDMs to. */
601 root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ());
603 /* [XML] MailServer Hostname of SMTP server to use. */
604 root->add_child("MailServer")->add_child_text (_mail_server);
605 /* [XML] MailPort Port number to use on SMTP server. */
606 root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
607 /* [XML] MailUser Username to use on SMTP server. */
608 root->add_child("MailUser")->add_child_text (_mail_user);
609 /* [XML] MailPassword Password to use on SMTP server. */
610 root->add_child("MailPassword")->add_child_text (_mail_password);
611 /* [XML] KDMSubject Subject to use for KDM emails. */
612 root->add_child("KDMSubject")->add_child_text (_kdm_subject);
613 /* [XML] KDMFrom From address to use for KDM emails. */
614 root->add_child("KDMFrom")->add_child_text (_kdm_from);
615 BOOST_FOREACH (string i, _kdm_cc) {
616 /* [XML] KDMCC CC address to use for KDM emails; you can use as many of these tags as you like. */
617 root->add_child("KDMCC")->add_child_text (i);
619 /* [XML] KDMBCC BCC address to use for KDM emails */
620 root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
621 /* [XML] KDMEmail Text of KDM email */
622 root->add_child("KDMEmail")->add_child_text (_kdm_email);
624 /* [XML] CheckForUpdates 1 to check dcpomatic.com for new versions, 0 to check only on request */
625 root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
626 /* [XML] CheckForUpdates 1 to check dcpomatic.com for new text versions, 0 to check only on request */
627 root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
629 /* [XML] MaximumJ2KBandwidth Maximum J2K bandwidth (in bits per second) that can be specified in the GUI */
630 root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
631 /* [XML] AllowAnyDCPFrameRate 1 to allow users to specify any frame rate when creating DCPs, 0 to limit the GUI to standard rates */
632 root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
633 /* [XML] LogTypes Types of logging to write; a bitfield where 1 is general notes, 2 warnings, 4 errors, 8 debug information related
634 to encoding, 16 debug information related to encoding, 32 debug information for timing purposes, 64 debug information related
637 root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
638 /* [XML] AnalyseEBUR128 1 to do EBUR128 analyses when analysing audio, otherwise 0. */
639 root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
640 /* [XML] AutomaticAudioAnalysis 1 to run audio analysis automatically when audio content is added to the film, otherwise 0. */
641 root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
642 #ifdef DCPOMATIC_WINDOWS
643 /* [XML] Win32Console 1 to open a console when running on Windows, otherwise 0. */
644 root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
647 /* [XML] Signer Certificate chain and private key to use when signing DCPs and KDMs. Should contain <code><Certificate></code>
648 tags in order and a <code><PrivateKey></code> tag all containing PEM-encoded certificates or private keys as appropriate.
650 xmlpp::Element* signer = root->add_child ("Signer");
651 DCPOMATIC_ASSERT (_signer_chain);
652 BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->unordered()) {
653 signer->add_child("Certificate")->add_child_text (i.certificate (true));
655 signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
657 /* [XML] Decryption Certificate chain and private key to use when decrypting KDMs */
658 xmlpp::Element* decryption = root->add_child ("Decryption");
659 DCPOMATIC_ASSERT (_decryption_chain);
660 BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->unordered()) {
661 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
663 decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
665 /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the GUI; there can be more than one
668 BOOST_FOREACH (boost::filesystem::path i, _history) {
669 root->add_child("History")->add_child_text (i.string ());
672 BOOST_FOREACH (boost::filesystem::path i, _player_history) {
673 root->add_child("PlayerHistory")->add_child_text (i.string ());
676 /* [XML] DKDMGroup A group of DKDMs, each with a <code>Name</code> attribute, containing other <code><DKDMGroup></code>
677 or <code><DKDM></code> tags.
679 /* [XML] DKDM A DKDM as XML */
680 _dkdms->as_xml (root);
682 /* [XML] CinemasFile Filename of cinemas list file */
683 root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
684 /* [XML] ShowHintsBeforeMakeDCP 1 to show hints in the GUI before making a DCP, otherwise 0 */
685 root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
686 /* [XML] ConfirmKDMEmail 1 to confirm before sending KDM emails in the GUI, otherwise 0 */
687 root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0");
688 /* [XML] KDMFilenameFormat Format for KDM filenames */
689 root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
690 /* [XML] KDMContainerNameFormat Format for KDM containers (directories or ZIP files) */
691 root->add_child("KDMContainerNameFormat")->add_child_text (_kdm_container_name_format.specification ());
692 /* [XML] DCPMetadataFilenameFormat Format for DCP metadata filenames */
693 root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ());
694 /* [XML] DCPAssetFilenameFormat Format for DCP asset filenames */
695 root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ());
696 /* [XML] JumpToSelected 1 to make the GUI jump to the start of content when it is selected, otherwise 0 */
697 root->add_child("JumpToSelected")->add_child_text (_jump_to_selected ? "1" : "0");
698 /* [XML] Nagged 1 if a particular nag screen has been shown and should not be shown again, otherwise 0 */
699 for (int i = 0; i < NAG_COUNT; ++i) {
700 xmlpp::Element* e = root->add_child ("Nagged");
701 e->set_attribute ("Id", raw_convert<string>(i));
702 e->add_child_text (_nagged[i] ? "1" : "0");
704 /* [XML] PreviewSound 1 to use sound in the GUI preview and player, otherwise 0 */
705 root->add_child("PreviewSound")->add_child_text (_sound ? "1" : "0");
707 /* [XML:opt] PreviewSoundOutput Name of the audio output to use */
708 root->add_child("PreviewSoundOutput")->add_child_text (_sound_output.get());
710 /* [XML] CoverSheet Text of the cover sheet to write when making DCPs */
711 root->add_child("CoverSheet")->add_child_text (_cover_sheet);
712 if (_last_player_load_directory) {
713 root->add_child("LastPlayerLoadDirectory")->add_child_text(_last_player_load_directory->string());
715 if (_last_kdm_write_type) {
716 switch (_last_kdm_write_type.get()) {
718 root->add_child("LastKDMWriteType")->add_child_text("flat");
720 case KDM_WRITE_FOLDER:
721 root->add_child("LastKDMWriteType")->add_child_text("folder");
724 root->add_child("LastKDMWriteType")->add_child_text("zip");
728 if (_last_dkdm_write_type) {
729 switch (_last_dkdm_write_type.get()) {
730 case DKDM_WRITE_INTERNAL:
731 root->add_child("LastDKDMWriteType")->add_child_text("internal");
733 case DKDM_WRITE_FILE:
734 root->add_child("LastDKDMWriteType")->add_child_text("file");
738 /* [XML] FramesInMemoryMultiplier value to multiply the encoding threads count by to get the maximum number of
739 frames to be held in memory at once.
741 root->add_child("FramesInMemoryMultiplier")->add_child_text(raw_convert<string>(_frames_in_memory_multiplier));
743 /* [XML] DecodeReduction power of 2 to reduce DCP images by before decoding in the player */
744 if (_decode_reduction) {
745 root->add_child("DecodeReduction")->add_child_text(raw_convert<string>(_decode_reduction.get()));
749 doc.write_to_file_formatted(config_file().string());
750 } catch (xmlpp::exception& e) {
751 string s = e.what ();
753 throw FileError (s, path("config.xml"));
758 Config::write_cinemas () const
761 xmlpp::Element* root = doc.create_root_node ("Cinemas");
762 root->add_child("Version")->add_child_text ("1");
764 BOOST_FOREACH (shared_ptr<Cinema> i, _cinemas) {
765 i->as_xml (root->add_child ("Cinema"));
769 doc.write_to_file_formatted (_cinemas_file.string ());
770 } catch (xmlpp::exception& e) {
771 string s = e.what ();
773 throw FileError (s, _cinemas_file);
777 boost::filesystem::path
778 Config::default_directory_or (boost::filesystem::path a) const
780 return directory_or (_default_directory, a);
783 boost::filesystem::path
784 Config::default_kdm_directory_or (boost::filesystem::path a) const
786 return directory_or (_default_kdm_directory, a);
789 boost::filesystem::path
790 Config::directory_or (optional<boost::filesystem::path> dir, boost::filesystem::path a) const
796 boost::system::error_code ec;
797 bool const e = boost::filesystem::exists (*dir, ec);
813 Config::changed (Property what)
819 Config::set_kdm_email_to_default ()
821 _kdm_subject = _("KDM delivery: $CPL_NAME");
824 "Dear Projectionist\n\n"
825 "Please find attached KDMs for $CPL_NAME.\n\n"
826 "Cinema: $CINEMA_NAME\n"
827 "Screen(s): $SCREENS\n\n"
828 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
829 "Best regards,\nDCP-o-matic"
834 Config::reset_kdm_email ()
836 set_kdm_email_to_default ();
841 Config::set_cover_sheet_to_default ()
846 "Format: $CONTAINER\n"
848 "Audio Language: $AUDIO_LANGUAGE\n"
849 "Subtitle Language: $SUBTITLE_LANGUAGE\n"
856 Config::add_to_history (boost::filesystem::path p)
858 add_to_history_internal (_history, p);
862 Config::add_to_player_history (boost::filesystem::path p)
864 add_to_history_internal (_player_history, p);
868 Config::add_to_history_internal (vector<boost::filesystem::path>& h, boost::filesystem::path p)
870 /* Remove existing instances of this path in the history */
871 h.erase (remove (h.begin(), h.end(), p), h.end ());
873 h.insert (h.begin (), p);
874 if (h.size() > HISTORY_SIZE) {
882 Config::have_existing (string file)
884 return boost::filesystem::exists (path (file, false));
888 Config::read_cinemas (cxml::Document const & f)
891 list<cxml::NodePtr> cin = f.node_children ("Cinema");
892 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Cinema")) {
893 /* Slightly grotty two-part construction of Cinema here so that we can use
896 shared_ptr<Cinema> cinema (new Cinema (i));
897 cinema->read_screens (i);
898 _cinemas.push_back (cinema);
903 Config::set_cinemas_file (boost::filesystem::path file)
905 _cinemas_file = file;
907 if (boost::filesystem::exists (_cinemas_file)) {
908 /* Existing file; read it in */
909 cxml::Document f ("Cinemas");
910 f.read_file (_cinemas_file);
918 Config::save_template (shared_ptr<const Film> film, string name) const
920 film->write_template (template_path (name));
924 Config::templates () const
926 if (!boost::filesystem::exists (path ("templates"))) {
927 return list<string> ();
931 for (boost::filesystem::directory_iterator i (path("templates")); i != boost::filesystem::directory_iterator(); ++i) {
932 n.push_back (i->path().filename().string());
938 Config::existing_template (string name) const
940 return boost::filesystem::exists (template_path (name));
943 boost::filesystem::path
944 Config::template_path (string name) const
946 return path("templates") / tidy_for_filename (name);
950 Config::rename_template (string old_name, string new_name) const
952 boost::filesystem::rename (template_path (old_name), template_path (new_name));
956 Config::delete_template (string name) const
958 boost::filesystem::remove (template_path (name));
961 /** @return Path to the config.xml containing the actual settings, following a link if required */
962 boost::filesystem::path
963 Config::config_file ()
965 cxml::Document f ("Config");
966 boost::filesystem::path main = path("config.xml", false);
967 if (!boost::filesystem::exists (main)) {
968 /* It doesn't exist, so there can't be any links; just return it */
972 /* See if there's a link */
974 optional<string> link = f.optional_string_child("Link");
983 Config::reset_cover_sheet ()
985 set_cover_sheet_to_default ();
990 Config::link (boost::filesystem::path new_file) const
993 doc.create_root_node("Config")->add_child("Link")->add_child_text(new_file.string());
995 doc.write_to_file_formatted(path("config.xml", true).string());
996 } catch (xmlpp::exception& e) {
997 string s = e.what ();
999 throw FileError (s, path("config.xml"));
1004 Config::copy_and_link (boost::filesystem::path new_file) const
1007 boost::filesystem::copy_file (config_file(), new_file, boost::filesystem::copy_option::overwrite_if_exists);