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::optional<boost::filesystem::path> Config::test_path;
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 = PROTOCOL_SCP;
94 _cinema_sound_processor = CinemaSoundProcessor::from_id (N_("dolby_cp750"));
95 _allow_any_dcp_frame_rate = false;
96 _language = optional<string> ();
97 _default_still_length = 10;
98 _default_container = Ratio::from_id ("185");
99 _default_scale_to = 0;
100 _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
101 _default_dcp_audio_channels = 6;
102 _default_j2k_bandwidth = 100000000;
103 _default_audio_delay = 0;
104 _default_interop = true;
105 _default_upload_after_make_dcp = false;
113 _check_for_updates = false;
114 _check_for_test_updates = false;
115 _maximum_j2k_bandwidth = 250000000;
116 _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR;
117 _analyse_ebur128 = true;
118 _automatic_audio_analysis = false;
119 #ifdef DCPOMATIC_WINDOWS
120 _win32_console = false;
122 _cinemas_file = path ("cinemas.xml");
123 _show_hints_before_make_dcp = true;
124 _confirm_kdm_email = true;
125 _kdm_container_name_format = dcp::NameFormat ("KDM %f %c");
126 _kdm_filename_format = dcp::NameFormat ("KDM %f %c %s");
127 _dcp_metadata_filename_format = dcp::NameFormat ("%t");
128 _dcp_asset_filename_format = dcp::NameFormat ("%t");
129 _jump_to_selected = true;
130 for (int i = 0; i < NAG_COUNT; ++i) {
134 _sound_output = optional<string> ();
135 _last_kdm_write_type = KDM_WRITE_FLAT;
136 _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
138 /* I think the scaling factor here should be the ratio of the longest frame
139 encode time to the shortest; if the thread count is T, longest time is L
140 and the shortest time S we could encode L/S frames per thread whilst waiting
141 for the L frame to encode so we might have to store LT/S frames.
143 However we don't want to use too much memory, so keep it a bit lower than we'd
144 perhaps like. A J2K frame is typically about 1Mb so 3 here will mean we could
145 use about 240Mb with 72 encoding threads.
147 _frames_in_memory_multiplier = 3;
148 _decode_reduction = optional<int>();
150 _allowed_dcp_frame_rates.clear ();
151 _allowed_dcp_frame_rates.push_back (24);
152 _allowed_dcp_frame_rates.push_back (25);
153 _allowed_dcp_frame_rates.push_back (30);
154 _allowed_dcp_frame_rates.push_back (48);
155 _allowed_dcp_frame_rates.push_back (50);
156 _allowed_dcp_frame_rates.push_back (60);
158 set_kdm_email_to_default ();
159 set_cover_sheet_to_default ();
163 Config::restore_defaults ()
165 Config::instance()->set_defaults ();
166 Config::instance()->changed ();
169 shared_ptr<dcp::CertificateChain>
170 Config::create_certificate_chain ()
172 return shared_ptr<dcp::CertificateChain> (
173 new dcp::CertificateChain (
177 ".dcpomatic.smpte-430-2.ROOT",
178 ".dcpomatic.smpte-430-2.INTERMEDIATE",
179 "CS.dcpomatic.smpte-430-2.LEAF"
187 /* Make a copy of the configuration */
190 while (n < 100 && boost::filesystem::exists(path(String::compose("config.xml.%1", n)))) {
194 boost::filesystem::copy_file(path("config.xml", false), path(String::compose("config.xml.%1", n), false));
195 boost::filesystem::copy_file(path("cinemas.xml", false), path(String::compose("cinemas.xml.%1", n), false));
203 cxml::Document f ("Config");
204 f.read_file (config_file ());
206 optional<int> version = f.optional_number_child<int> ("Version");
207 if (version && *version < _current_version) {
208 /* Back up the old config before we re-write it in a back-incompatible way */
212 if (f.optional_number_child<int>("NumLocalEncodingThreads")) {
213 _master_encoding_threads = _server_encoding_threads = f.optional_number_child<int>("NumLocalEncodingThreads").get();
215 _master_encoding_threads = f.number_child<int>("MasterEncodingThreads");
216 _server_encoding_threads = f.number_child<int>("ServerEncodingThreads");
219 _default_directory = f.optional_string_child ("DefaultDirectory");
220 if (_default_directory && _default_directory->empty ()) {
221 /* We used to store an empty value for this to mean "none set" */
222 _default_directory = boost::optional<boost::filesystem::path> ();
225 boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
227 b = f.optional_number_child<int> ("ServerPortBase");
229 _server_port_base = b.get ();
231 boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
232 _use_any_servers = u.get_value_or (true);
234 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Server")) {
235 if (i->node_children("HostName").size() == 1) {
236 _servers.push_back (i->string_child ("HostName"));
238 _servers.push_back (i->content ());
242 _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
243 _tms_protocol = static_cast<Protocol> (f.optional_number_child<int> ("TMSProtocol").get_value_or (static_cast<int> (PROTOCOL_SCP)));
244 _tms_ip = f.string_child ("TMSIP");
245 _tms_path = f.string_child ("TMSPath");
246 _tms_user = f.string_child ("TMSUser");
247 _tms_password = f.string_child ("TMSPassword");
250 c = f.optional_string_child ("SoundProcessor");
252 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
254 c = f.optional_string_child ("CinemaSoundProcessor");
256 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
259 _language = f.optional_string_child ("Language");
261 c = f.optional_string_child ("DefaultContainer");
263 _default_container = Ratio::from_id (c.get ());
266 if (_default_container && !_default_container->used_for_container()) {
267 Warning (_("Your default container is not valid and has been changed to Flat (1.85:1)"));
268 _default_container = Ratio::from_id ("185");
271 c = f.optional_string_child ("DefaultScaleTo");
273 _default_scale_to = Ratio::from_id (c.get ());
276 _default_dcp_content_type = DCPContentType::from_isdcf_name(f.optional_string_child("DefaultDCPContentType").get_value_or("FTR"));
277 _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
279 if (f.optional_string_child ("DCPMetadataIssuer")) {
280 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
281 } else if (f.optional_string_child ("DCPIssuer")) {
282 _dcp_issuer = f.string_child ("DCPIssuer");
285 _default_upload_after_make_dcp = f.optional_bool_child("DefaultUploadAfterMakeDCP").get_value_or (false);
286 _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
288 if (version && version.get() >= 2) {
289 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
291 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
294 _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
295 _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
296 _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
297 _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
298 _default_kdm_directory = f.optional_string_child("DefaultKDMDirectory");
300 /* Load any cinemas from config.xml */
303 _mail_server = f.string_child ("MailServer");
304 _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
305 _mail_user = f.optional_string_child("MailUser").get_value_or ("");
306 _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
307 _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
308 _kdm_from = f.string_child ("KDMFrom");
309 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("KDMCC")) {
310 if (!i->content().empty()) {
311 _kdm_cc.push_back (i->content ());
314 _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
315 _kdm_email = f.string_child ("KDMEmail");
317 _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
318 _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
320 _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
321 _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
323 _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
324 _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
325 _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
326 #ifdef DCPOMATIC_WINDOWS
327 _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
330 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("History")) {
331 _history.push_back (i->content ());
334 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("PlayerHistory")) {
335 _player_history.push_back (i->content ());
338 cxml::NodePtr signer = f.optional_node_child ("Signer");
340 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
341 /* Read the signing certificates and private key in from the config file */
342 BOOST_FOREACH (cxml::NodePtr i, signer->node_children ("Certificate")) {
343 c->add (dcp::Certificate (i->content ()));
345 c->set_key (signer->string_child ("PrivateKey"));
348 /* Make a new set of signing certificates and key */
349 _signer_chain = create_certificate_chain ();
352 cxml::NodePtr decryption = f.optional_node_child ("Decryption");
354 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
355 BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) {
356 c->add (dcp::Certificate (i->content ()));
358 c->set_key (decryption->string_child ("PrivateKey"));
359 _decryption_chain = c;
361 _decryption_chain = create_certificate_chain ();
364 if (f.optional_node_child("DKDMGroup")) {
365 /* New-style: all DKDMs in a group */
366 _dkdms = dynamic_pointer_cast<DKDMGroup> (DKDMBase::read (f.node_child("DKDMGroup")));
368 /* Old-style: one or more DKDM nodes */
369 _dkdms.reset (new DKDMGroup ("root"));
370 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("DKDM")) {
371 _dkdms->add (DKDMBase::read (i));
374 _cinemas_file = f.optional_string_child("CinemasFile").get_value_or (path ("cinemas.xml").string ());
375 _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
376 _confirm_kdm_email = f.optional_bool_child("ConfirmKDMEmail").get_value_or (true);
377 _kdm_container_name_format = dcp::NameFormat (f.optional_string_child("KDMContainerNameFormat").get_value_or ("KDM %f %c"));
378 _kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
379 _dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t"));
380 _dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t"));
381 _jump_to_selected = f.optional_bool_child("JumpToSelected").get_value_or (true);
382 BOOST_FOREACH (cxml::NodePtr i, f.node_children("Nagged")) {
383 int const id = i->number_attribute<int>("Id");
384 if (id >= 0 && id < NAG_COUNT) {
385 _nagged[id] = raw_convert<int>(i->content());
388 /* The variable was renamed but not the XML tag */
389 _sound = f.optional_bool_child("PreviewSound").get_value_or (true);
390 _sound_output = f.optional_string_child("PreviewSoundOutput");
391 if (f.optional_string_child("CoverSheet")) {
392 _cover_sheet = f.optional_string_child("CoverSheet").get();
394 _last_player_load_directory = f.optional_string_child("LastPlayerLoadDirectory");
395 if (f.optional_string_child("LastKDMWriteType")) {
396 if (f.optional_string_child("LastKDMWriteType").get() == "flat") {
397 _last_kdm_write_type = KDM_WRITE_FLAT;
398 } else if (f.optional_string_child("LastKDMWriteType").get() == "folder") {
399 _last_kdm_write_type = KDM_WRITE_FOLDER;
400 } else if (f.optional_string_child("LastKDMWriteType").get() == "zip") {
401 _last_kdm_write_type = KDM_WRITE_ZIP;
404 if (f.optional_string_child("LastDKDMWriteType")) {
405 if (f.optional_string_child("LastDKDMWriteType").get() == "internal") {
406 _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
407 } else if (f.optional_string_child("LastDKDMWriteType").get() == "file") {
408 _last_dkdm_write_type = DKDM_WRITE_FILE;
411 _frames_in_memory_multiplier = f.optional_number_child<int>("FramesInMemoryMultiplier").get_value_or(3);
412 _decode_reduction = f.optional_number_child<int>("DecodeReduction");
414 /* Replace any cinemas from config.xml with those from the configured file */
415 if (boost::filesystem::exists (_cinemas_file)) {
416 cxml::Document f ("Cinemas");
417 f.read_file (_cinemas_file);
422 if (have_existing ("config.xml")) {
424 /* We have a config file but it didn't load */
428 /* Make a new set of signing certificates and key */
429 _signer_chain = create_certificate_chain ();
430 /* And similar for decryption of KDMs */
431 _decryption_chain = create_certificate_chain ();
435 /** @return Filename to write configuration to */
436 boost::filesystem::path
437 Config::path (string file, bool create_directories)
439 boost::filesystem::path p;
444 p /= g_get_home_dir ();
447 p /= "com.dcpomatic";
450 p /= g_get_user_config_dir ();
454 boost::system::error_code ec;
455 if (create_directories) {
456 boost::filesystem::create_directories (p, ec);
462 /** @return Singleton instance */
466 if (_instance == 0) {
467 _instance = new Config;
474 /** Write our configuration to disk */
476 Config::write () const
483 Config::write_config () const
486 xmlpp::Element* root = doc.create_root_node ("Config");
488 /* [XML] Version The version number of the configuration file format */
489 root->add_child("Version")->add_child_text (String::compose ("%1", _current_version));
490 /* [XML] MasterEncodingThreads Number of encoding threads to use when running as master. */
491 root->add_child("MasterEncodingThreads")->add_child_text (raw_convert<string> (_master_encoding_threads));
492 /* [XML] ServerEncodingThreads Number of encoding threads to use when running as server. */
493 root->add_child("ServerEncodingThreads")->add_child_text (raw_convert<string> (_server_encoding_threads));
494 if (_default_directory) {
495 /* [XML:opt] DefaultDirectory Default directory when creating a new film in the GUI. */
496 root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ());
498 /* [XML] ServerPortBase Port number to use for frame encoding requests. <code>ServerPortBase</code> + 1 and
499 <code>ServerPortBase</code> + 2 are used for querying servers. <code>ServerPortBase</code> + 3 is used
500 by the batch converter to listen for job requests.
502 root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
503 /* [XML] UseAnyServers 1 to broadcast to look for encoding servers to use, 0 to use only those configured. */
504 root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
506 BOOST_FOREACH (string i, _servers) {
507 /* [XML:opt] Server IP address or hostname of an encoding server to use; you can use as many of these tags
510 root->add_child("Server")->add_child_text (i);
513 /* [XML] OnlyServersEncode 1 to set the master to do decoding of source content no JPEG2000 encoding; all encoding
514 is done by the encoding servers. 0 to set the master to do some encoding as well as coordinating the job.
516 root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
517 /* [XML] TMSProtocol Protocol to use to copy files to a TMS; 0 to use SCP, 1 for FTP. */
518 root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
519 /* [XML] TMSIP IP address of TMS */
520 root->add_child("TMSIP")->add_child_text (_tms_ip);
521 /* [XML] TMSPath Path on the TMS to copy files to */
522 root->add_child("TMSPath")->add_child_text (_tms_path);
523 /* [XML] TMSUser Username to log into the TMS with */
524 root->add_child("TMSUser")->add_child_text (_tms_user);
525 /* [XML] TMSPassword Password to log into the TMS with */
526 root->add_child("TMSPassword")->add_child_text (_tms_password);
527 if (_cinema_sound_processor) {
528 /* [XML:opt] CinemaSoundProcessor Identifier of the type of cinema sound processor to use when calculating
529 gain changes from fader positions. Currently can only be <code>dolby_cp750</code>.
531 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
534 /* [XML:opt] Language Language to use in the GUI e.g. <code>fr_FR</code>. */
535 root->add_child("Language")->add_child_text (_language.get());
537 if (_default_container) {
538 /* [XML:opt] DefaultContainer ID of default container
539 * to use when creating new films (<code>185</code>,<code>239</code> or
542 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
544 if (_default_scale_to) {
545 /* [XML:opt] DefaultScaleTo ID of default ratio to scale content to when creating new films
546 (see <code>DefaultContainer</code> for IDs).
548 root->add_child("DefaultScaleTo")->add_child_text (_default_scale_to->id ());
550 if (_default_dcp_content_type) {
551 /* [XML:opt] DefaultDCPContentType Default content type ot use when creating new films (<code>FTR</code>, <code>SHR</code>,
552 <code>TLR</code>, <code>TST</code>, <code>XSN</code>, <code>RTG</code>, <code>TSR</code>, <code>POL</code>,
553 <code>PSA</code> or <code>ADV</code>). */
554 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
556 /* [XML] DefaultDCPAudioChannels Default number of audio channels to use when creating new films. */
557 root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
558 /* [XML] DCPIssuer Issuer text to write into CPL files. */
559 root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
560 /* [XML] DCPIssuer Creator text to write into CPL files. */
561 root->add_child("DCPCreator")->add_child_text (_dcp_creator);
562 root->add_child("DefaultUploadAfterMakeDCP")->add_child_text (_default_upload_after_make_dcp ? "1" : "0");
564 /* [XML] ISDCFMetadata Default ISDCF metadata to use for new films; child tags are <code><ContentVersion></code>,
565 <code><AudioLanguage></code>, <code><SubtitleLanguage></code>, <code><Territory></code>,
566 <code><Rating></code>, <code><Studio></code>, <code><Facility></code>, <code><TempVersion></code>,
567 <code><PreRelease></code>, <code><RedBand></code>, <code><Chain></code>, <code><TwoDVersionOFThreeD></code>,
568 <code><MasteredLuminance></code>.
570 _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
572 /* [XML] DefaultStillLength Default length (in seconds) for still images in new films. */
573 root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
574 /* [XML] DefaultJ2KBandwidth Default bitrate (in bits per second) for JPEG2000 data in new films. */
575 root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
576 /* [XML] DefaultAudioDelay Default delay to apply to audio (positive moves audio later) in milliseconds. */
577 root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
578 /* [XML] DefaultInterop 1 to default new films to Interop, 0 for SMPTE. */
579 root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
580 if (_default_kdm_directory) {
581 /* [XML:opt] DefaultKDMDirectory Default directory to write KDMs to. */
582 root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ());
584 /* [XML] MailServer Hostname of SMTP server to use. */
585 root->add_child("MailServer")->add_child_text (_mail_server);
586 /* [XML] MailPort Port number to use on SMTP server. */
587 root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
588 /* [XML] MailUser Username to use on SMTP server. */
589 root->add_child("MailUser")->add_child_text (_mail_user);
590 /* [XML] MailPassword Password to use on SMTP server. */
591 root->add_child("MailPassword")->add_child_text (_mail_password);
592 /* [XML] KDMSubject Subject to use for KDM emails. */
593 root->add_child("KDMSubject")->add_child_text (_kdm_subject);
594 /* [XML] KDMFrom From address to use for KDM emails. */
595 root->add_child("KDMFrom")->add_child_text (_kdm_from);
596 BOOST_FOREACH (string i, _kdm_cc) {
597 /* [XML] KDMCC CC address to use for KDM emails; you can use as many of these tags as you like. */
598 root->add_child("KDMCC")->add_child_text (i);
600 /* [XML] KDMBCC BCC address to use for KDM emails */
601 root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
602 /* [XML] KDMEmail Text of KDM email */
603 root->add_child("KDMEmail")->add_child_text (_kdm_email);
605 /* [XML] CheckForUpdates 1 to check dcpomatic.com for new versions, 0 to check only on request */
606 root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
607 /* [XML] CheckForUpdates 1 to check dcpomatic.com for new text versions, 0 to check only on request */
608 root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
610 /* [XML] MaximumJ2KBandwidth Maximum J2K bandwidth (in bits per second) that can be specified in the GUI */
611 root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
612 /* [XML] AllowAnyDCPFrameRate 1 to allow users to specify any frame rate when creating DCPs, 0 to limit the GUI to standard rates */
613 root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
614 /* [XML] LogTypes Types of logging to write; a bitfield where 1 is general notes, 2 warnings, 4 errors, 8 debug information related
615 to encoding, 16 debug information related to encoding, 32 debug information for timing purposes, 64 debug information related
618 root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
619 /* [XML] AnalyseEBUR128 1 to do EBUR128 analyses when analysing audio, otherwise 0. */
620 root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
621 /* [XML] AutomaticAudioAnalysis 1 to run audio analysis automatically when audio content is added to the film, otherwise 0. */
622 root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
623 #ifdef DCPOMATIC_WINDOWS
624 /* [XML] Win32Console 1 to open a console when running on Windows, otherwise 0. */
625 root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
628 /* [XML] Signer Certificate chain and private key to use when signing DCPs and KDMs. Should contain <code><Certificate></code>
629 tags in order and a <code><PrivateKey></code> tag all containing PEM-encoded certificates or private keys as appropriate.
631 xmlpp::Element* signer = root->add_child ("Signer");
632 DCPOMATIC_ASSERT (_signer_chain);
633 BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->unordered()) {
634 signer->add_child("Certificate")->add_child_text (i.certificate (true));
636 signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
638 /* [XML] Decryption Certificate chain and private key to use when decrypting KDMs */
639 xmlpp::Element* decryption = root->add_child ("Decryption");
640 DCPOMATIC_ASSERT (_decryption_chain);
641 BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->unordered()) {
642 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
644 decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
646 /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the GUI; there can be more than one
649 BOOST_FOREACH (boost::filesystem::path i, _history) {
650 root->add_child("History")->add_child_text (i.string ());
653 BOOST_FOREACH (boost::filesystem::path i, _player_history) {
654 root->add_child("PlayerHistory")->add_child_text (i.string ());
657 /* [XML] DKDMGroup A group of DKDMs, each with a <code>Name</code> attribute, containing other <code><DKDMGroup></code>
658 or <code><DKDM></code> tags.
660 /* [XML] DKDM A DKDM as XML */
661 _dkdms->as_xml (root);
663 /* [XML] CinemasFile Filename of cinemas list file */
664 root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
665 /* [XML] ShowHintsBeforeMakeDCP 1 to show hints in the GUI before making a DCP, otherwise 0 */
666 root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
667 /* [XML] ConfirmKDMEmail 1 to confirm before sending KDM emails in the GUI, otherwise 0 */
668 root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0");
669 /* [XML] KDMFilenameFormat Format for KDM filenames */
670 root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
671 /* [XML] KDMContainerNameFormat Format for KDM containers (directories or ZIP files) */
672 root->add_child("KDMContainerNameFormat")->add_child_text (_kdm_container_name_format.specification ());
673 /* [XML] DCPMetadataFilenameFormat Format for DCP metadata filenames */
674 root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ());
675 /* [XML] DCPAssetFilenameFormat Format for DCP asset filenames */
676 root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ());
677 /* [XML] JumpToSelected 1 to make the GUI jump to the start of content when it is selected, otherwise 0 */
678 root->add_child("JumpToSelected")->add_child_text (_jump_to_selected ? "1" : "0");
679 /* [XML] Nagged 1 if a particular nag screen has been shown and should not be shown again, otherwise 0 */
680 for (int i = 0; i < NAG_COUNT; ++i) {
681 xmlpp::Element* e = root->add_child ("Nagged");
682 e->set_attribute ("Id", raw_convert<string>(i));
683 e->add_child_text (_nagged[i] ? "1" : "0");
685 /* [XML] PreviewSound 1 to use sound in the GUI preview and player, otherwise 0 */
686 root->add_child("PreviewSound")->add_child_text (_sound ? "1" : "0");
688 /* [XML:opt] PreviewSoundOutput Name of the audio output to use */
689 root->add_child("PreviewSoundOutput")->add_child_text (_sound_output.get());
691 /* [XML] CoverSheet Text of the cover sheet to write when making DCPs */
692 root->add_child("CoverSheet")->add_child_text (_cover_sheet);
693 if (_last_player_load_directory) {
694 root->add_child("LastPlayerLoadDirectory")->add_child_text(_last_player_load_directory->string());
696 if (_last_kdm_write_type) {
697 switch (_last_kdm_write_type.get()) {
699 root->add_child("LastKDMWriteType")->add_child_text("flat");
701 case KDM_WRITE_FOLDER:
702 root->add_child("LastKDMWriteType")->add_child_text("folder");
705 root->add_child("LastKDMWriteType")->add_child_text("zip");
709 if (_last_dkdm_write_type) {
710 switch (_last_dkdm_write_type.get()) {
711 case DKDM_WRITE_INTERNAL:
712 root->add_child("LastDKDMWriteType")->add_child_text("internal");
714 case DKDM_WRITE_FILE:
715 root->add_child("LastDKDMWriteType")->add_child_text("file");
719 /* [XML] FramesInMemoryMultiplier value to multiply the encoding threads count by to get the maximum number of
720 frames to be held in memory at once.
722 root->add_child("FramesInMemoryMultiplier")->add_child_text(raw_convert<string>(_frames_in_memory_multiplier));
724 /* [XML] DecodeReduction power of 2 to reduce DCP images by before decoding in the player */
725 if (_decode_reduction) {
726 root->add_child("DecodeReduction")->add_child_text(raw_convert<string>(_decode_reduction.get()));
730 doc.write_to_file_formatted(config_file().string());
731 } catch (xmlpp::exception& e) {
732 string s = e.what ();
734 throw FileError (s, path("config.xml"));
739 Config::write_cinemas () const
742 xmlpp::Element* root = doc.create_root_node ("Cinemas");
743 root->add_child("Version")->add_child_text ("1");
745 BOOST_FOREACH (shared_ptr<Cinema> i, _cinemas) {
746 i->as_xml (root->add_child ("Cinema"));
750 doc.write_to_file_formatted (_cinemas_file.string ());
751 } catch (xmlpp::exception& e) {
752 string s = e.what ();
754 throw FileError (s, _cinemas_file);
758 boost::filesystem::path
759 Config::default_directory_or (boost::filesystem::path a) const
761 return directory_or (_default_directory, a);
764 boost::filesystem::path
765 Config::default_kdm_directory_or (boost::filesystem::path a) const
767 return directory_or (_default_kdm_directory, a);
770 boost::filesystem::path
771 Config::directory_or (optional<boost::filesystem::path> dir, boost::filesystem::path a) const
777 boost::system::error_code ec;
778 bool const e = boost::filesystem::exists (*dir, ec);
794 Config::changed (Property what)
800 Config::set_kdm_email_to_default ()
802 _kdm_subject = _("KDM delivery: $CPL_NAME");
805 "Dear Projectionist\n\n"
806 "Please find attached KDMs for $CPL_NAME.\n\n"
807 "Cinema: $CINEMA_NAME\n"
808 "Screen(s): $SCREENS\n\n"
809 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
810 "Best regards,\nDCP-o-matic"
815 Config::reset_kdm_email ()
817 set_kdm_email_to_default ();
822 Config::set_cover_sheet_to_default ()
827 "Format: $CONTAINER\n"
829 "Audio Language: $AUDIO_LANGUAGE\n"
830 "Subtitle Language: $SUBTITLE_LANGUAGE\n"
837 Config::add_to_history (boost::filesystem::path p)
839 add_to_history_internal (_history, p);
843 Config::add_to_player_history (boost::filesystem::path p)
845 add_to_history_internal (_player_history, p);
849 Config::add_to_history_internal (vector<boost::filesystem::path>& h, boost::filesystem::path p)
851 /* Remove existing instances of this path in the history */
852 h.erase (remove (h.begin(), h.end(), p), h.end ());
854 h.insert (h.begin (), p);
855 if (h.size() > HISTORY_SIZE) {
863 Config::have_existing (string file)
865 return boost::filesystem::exists (path (file, false));
869 Config::read_cinemas (cxml::Document const & f)
872 list<cxml::NodePtr> cin = f.node_children ("Cinema");
873 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Cinema")) {
874 /* Slightly grotty two-part construction of Cinema here so that we can use
877 shared_ptr<Cinema> cinema (new Cinema (i));
878 cinema->read_screens (i);
879 _cinemas.push_back (cinema);
884 Config::set_cinemas_file (boost::filesystem::path file)
886 _cinemas_file = file;
888 if (boost::filesystem::exists (_cinemas_file)) {
889 /* Existing file; read it in */
890 cxml::Document f ("Cinemas");
891 f.read_file (_cinemas_file);
899 Config::save_template (shared_ptr<const Film> film, string name) const
901 film->write_template (template_path (name));
905 Config::templates () const
907 if (!boost::filesystem::exists (path ("templates"))) {
908 return list<string> ();
912 for (boost::filesystem::directory_iterator i (path("templates")); i != boost::filesystem::directory_iterator(); ++i) {
913 n.push_back (i->path().filename().string());
919 Config::existing_template (string name) const
921 return boost::filesystem::exists (template_path (name));
924 boost::filesystem::path
925 Config::template_path (string name) const
927 return path("templates") / tidy_for_filename (name);
931 Config::rename_template (string old_name, string new_name) const
933 boost::filesystem::rename (template_path (old_name), template_path (new_name));
937 Config::delete_template (string name) const
939 boost::filesystem::remove (template_path (name));
942 /** @return Path to the config.xml containing the actual settings, following a link if required */
943 boost::filesystem::path
944 Config::config_file ()
946 cxml::Document f ("Config");
947 boost::filesystem::path main = path("config.xml", false);
948 if (!boost::filesystem::exists (main)) {
949 /* It doesn't exist, so there can't be any links; just return it */
953 /* See if there's a link */
955 optional<string> link = f.optional_string_child("Link");
964 Config::reset_cover_sheet ()
966 set_cover_sheet_to_default ();
971 Config::link (boost::filesystem::path new_file) const
974 doc.create_root_node("Config")->add_child("Link")->add_child_text(new_file.string());
976 doc.write_to_file_formatted(path("config.xml", true).string());
977 } catch (xmlpp::exception& e) {
978 string s = e.what ();
980 throw FileError (s, path("config.xml"));
985 Config::copy_and_link (boost::filesystem::path new_file) const
988 boost::filesystem::copy_file (config_file(), new_file, boost::filesystem::copy_option::overwrite_if_exists);