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 boost::signals2::signal<void ()> Config::FailedToLoad;
68 boost::signals2::signal<void (string)> Config::Warning;
69 boost::optional<boost::filesystem::path> Config::test_path;
71 /** Construct default configuration */
73 /* DKDMs are not considered a thing to reset on set_defaults() */
74 : _dkdms (new DKDMGroup ("root"))
80 Config::set_defaults ()
82 _master_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
83 _server_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
84 _server_port_base = 6192;
85 _use_any_servers = true;
87 _only_servers_encode = false;
88 _tms_protocol = PROTOCOL_SCP;
93 _cinema_sound_processor = CinemaSoundProcessor::from_id (N_("dolby_cp750"));
94 _allow_any_dcp_frame_rate = false;
95 _language = optional<string> ();
96 _default_still_length = 10;
97 _default_container = Ratio::from_id ("185");
98 _default_scale_to = 0;
99 _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
100 _default_dcp_audio_channels = 6;
101 _default_j2k_bandwidth = 100000000;
102 _default_audio_delay = 0;
103 _default_interop = true;
104 _default_upload_after_make_dcp = false;
112 _check_for_updates = false;
113 _check_for_test_updates = false;
114 _maximum_j2k_bandwidth = 250000000;
115 _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR;
116 _analyse_ebur128 = true;
117 _automatic_audio_analysis = false;
118 #ifdef DCPOMATIC_WINDOWS
119 _win32_console = false;
121 _cinemas_file = path ("cinemas.xml");
122 _show_hints_before_make_dcp = true;
123 _confirm_kdm_email = true;
124 _kdm_container_name_format = dcp::NameFormat ("KDM %f %c");
125 _kdm_filename_format = dcp::NameFormat ("KDM %f %c %s");
126 _dcp_metadata_filename_format = dcp::NameFormat ("%t");
127 _dcp_asset_filename_format = dcp::NameFormat ("%t");
128 _jump_to_selected = true;
129 for (int i = 0; i < NAG_COUNT; ++i) {
133 _sound_output = optional<string> ();
134 _last_kdm_write_type = KDM_WRITE_FLAT;
136 /* I think the scaling factor here should be the ratio of the longest frame
137 encode time to the shortest; if the thread count is T, longest time is L
138 and the shortest time S we could encode L/S frames per thread whilst waiting
139 for the L frame to encode so we might have to store LT/S frames.
141 However we don't want to use too much memory, so keep it a bit lower than we'd
142 perhaps like. A J2K frame is typically about 1Mb so 3 here will mean we could
143 use about 240Mb with 72 encoding threads.
145 _frames_in_memory_multiplier = 3;
147 _allowed_dcp_frame_rates.clear ();
148 _allowed_dcp_frame_rates.push_back (24);
149 _allowed_dcp_frame_rates.push_back (25);
150 _allowed_dcp_frame_rates.push_back (30);
151 _allowed_dcp_frame_rates.push_back (48);
152 _allowed_dcp_frame_rates.push_back (50);
153 _allowed_dcp_frame_rates.push_back (60);
155 set_kdm_email_to_default ();
156 set_cover_sheet_to_default ();
160 Config::restore_defaults ()
162 Config::instance()->set_defaults ();
163 Config::instance()->changed ();
166 shared_ptr<dcp::CertificateChain>
167 Config::create_certificate_chain ()
169 return shared_ptr<dcp::CertificateChain> (
170 new dcp::CertificateChain (
174 ".dcpomatic.smpte-430-2.ROOT",
175 ".dcpomatic.smpte-430-2.INTERMEDIATE",
176 "CS.dcpomatic.smpte-430-2.LEAF"
185 cxml::Document f ("Config");
186 f.read_file (config_file ());
188 optional<int> version = f.optional_number_child<int> ("Version");
190 if (f.optional_number_child<int>("NumLocalEncodingThreads")) {
191 _master_encoding_threads = _server_encoding_threads = f.optional_number_child<int>("NumLocalEncodingThreads").get();
193 _master_encoding_threads = f.number_child<int>("MasterEncodingThreads");
194 _server_encoding_threads = f.number_child<int>("ServerEncodingThreads");
197 _default_directory = f.optional_string_child ("DefaultDirectory");
198 if (_default_directory && _default_directory->empty ()) {
199 /* We used to store an empty value for this to mean "none set" */
200 _default_directory = boost::optional<boost::filesystem::path> ();
203 boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
205 b = f.optional_number_child<int> ("ServerPortBase");
207 _server_port_base = b.get ();
209 boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
210 _use_any_servers = u.get_value_or (true);
212 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Server")) {
213 if (i->node_children("HostName").size() == 1) {
214 _servers.push_back (i->string_child ("HostName"));
216 _servers.push_back (i->content ());
220 _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
221 _tms_protocol = static_cast<Protocol> (f.optional_number_child<int> ("TMSProtocol").get_value_or (static_cast<int> (PROTOCOL_SCP)));
222 _tms_ip = f.string_child ("TMSIP");
223 _tms_path = f.string_child ("TMSPath");
224 _tms_user = f.string_child ("TMSUser");
225 _tms_password = f.string_child ("TMSPassword");
228 c = f.optional_string_child ("SoundProcessor");
230 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
232 c = f.optional_string_child ("CinemaSoundProcessor");
234 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
237 _language = f.optional_string_child ("Language");
239 c = f.optional_string_child ("DefaultContainer");
241 _default_container = Ratio::from_id (c.get ());
244 if (_default_container && !_default_container->used_for_container()) {
245 Warning (_("Your default container is not valid and has been changed to Flat (1.85:1)"));
246 _default_container = Ratio::from_id ("185");
249 c = f.optional_string_child ("DefaultScaleTo");
251 _default_scale_to = Ratio::from_id (c.get ());
254 c = f.optional_string_child ("DefaultDCPContentType");
256 _default_dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
259 _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
261 if (f.optional_string_child ("DCPMetadataIssuer")) {
262 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
263 } else if (f.optional_string_child ("DCPIssuer")) {
264 _dcp_issuer = f.string_child ("DCPIssuer");
267 _default_upload_after_make_dcp = f.optional_bool_child("DefaultUploadAfterMakeDCP").get_value_or (false);
268 _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
270 if (version && version.get() >= 2) {
271 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
273 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
276 _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
277 _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
278 _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
279 _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
280 _default_kdm_directory = f.optional_string_child("DefaultKDMDirectory");
282 /* Load any cinemas from config.xml */
285 _mail_server = f.string_child ("MailServer");
286 _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
287 _mail_user = f.optional_string_child("MailUser").get_value_or ("");
288 _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
289 _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
290 _kdm_from = f.string_child ("KDMFrom");
291 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("KDMCC")) {
292 if (!i->content().empty()) {
293 _kdm_cc.push_back (i->content ());
296 _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
297 _kdm_email = f.string_child ("KDMEmail");
299 _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
300 _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
302 _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
303 _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
305 _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
306 _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
307 _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
308 #ifdef DCPOMATIC_WINDOWS
309 _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
312 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("History")) {
313 _history.push_back (i->content ());
316 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("PlayerHistory")) {
317 _player_history.push_back (i->content ());
320 cxml::NodePtr signer = f.optional_node_child ("Signer");
322 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
323 /* Read the signing certificates and private key in from the config file */
324 BOOST_FOREACH (cxml::NodePtr i, signer->node_children ("Certificate")) {
325 c->add (dcp::Certificate (i->content ()));
327 c->set_key (signer->string_child ("PrivateKey"));
330 /* Make a new set of signing certificates and key */
331 _signer_chain = create_certificate_chain ();
334 cxml::NodePtr decryption = f.optional_node_child ("Decryption");
336 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
337 BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) {
338 c->add (dcp::Certificate (i->content ()));
340 c->set_key (decryption->string_child ("PrivateKey"));
341 _decryption_chain = c;
343 _decryption_chain = create_certificate_chain ();
346 if (f.optional_node_child("DKDMGroup")) {
347 /* New-style: all DKDMs in a group */
348 _dkdms = dynamic_pointer_cast<DKDMGroup> (DKDMBase::read (f.node_child("DKDMGroup")));
350 /* Old-style: one or more DKDM nodes */
351 _dkdms.reset (new DKDMGroup ("root"));
352 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("DKDM")) {
353 _dkdms->add (DKDMBase::read (i));
356 _cinemas_file = f.optional_string_child("CinemasFile").get_value_or (path ("cinemas.xml").string ());
357 _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
358 _confirm_kdm_email = f.optional_bool_child("ConfirmKDMEmail").get_value_or (true);
359 _kdm_container_name_format = dcp::NameFormat (f.optional_string_child("KDMContainerNameFormat").get_value_or ("KDM %f %c"));
360 _kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
361 _dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t"));
362 _dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t"));
363 _jump_to_selected = f.optional_bool_child("JumpToSelected").get_value_or (true);
364 BOOST_FOREACH (cxml::NodePtr i, f.node_children("Nagged")) {
365 int const id = i->number_attribute<int>("Id");
366 if (id >= 0 && id < NAG_COUNT) {
367 _nagged[id] = raw_convert<int>(i->content());
370 /* The variable was renamed but not the XML tag */
371 _sound = f.optional_bool_child("PreviewSound").get_value_or (true);
372 _sound_output = f.optional_string_child("PreviewSoundOutput");
373 if (f.optional_string_child("CoverSheet")) {
374 _cover_sheet = f.optional_string_child("CoverSheet").get();
376 _last_player_load_directory = f.optional_string_child("LastPlayerLoadDirectory");
377 if (f.optional_string_child("LastKDMWriteType")) {
378 if (f.optional_string_child("LastKDMWriteType").get() == "flat") {
379 _last_kdm_write_type = KDM_WRITE_FLAT;
380 } else if (f.optional_string_child("LastKDMWriteType").get() == "folder") {
381 _last_kdm_write_type = KDM_WRITE_FOLDER;
382 } else if (f.optional_string_child("LastKDMWriteType").get() == "zip") {
383 _last_kdm_write_type = KDM_WRITE_ZIP;
386 _frames_in_memory_multiplier = f.optional_number_child<int>("FramesInMemoryMultiplier").get_value_or(3);
388 /* Replace any cinemas from config.xml with those from the configured file */
389 if (boost::filesystem::exists (_cinemas_file)) {
390 cxml::Document f ("Cinemas");
391 f.read_file (_cinemas_file);
396 if (have_existing ("config.xml")) {
398 /* Make a copy of the configuration */
401 while (n < 100 && boost::filesystem::exists(path(String::compose("config.xml.%1", n)))) {
405 boost::filesystem::copy_file(path("config.xml", false), path(String::compose("config.xml.%1", n), false));
406 boost::filesystem::copy_file(path("cinemas.xml", false), path(String::compose("cinemas.xml.%1", n), false));
409 /* We have a config file but it didn't load */
413 /* Make a new set of signing certificates and key */
414 _signer_chain = create_certificate_chain ();
415 /* And similar for decryption of KDMs */
416 _decryption_chain = create_certificate_chain ();
420 /** @return Filename to write configuration to */
421 boost::filesystem::path
422 Config::path (string file, bool create_directories)
424 boost::filesystem::path p;
429 p /= g_get_home_dir ();
432 p /= "com.dcpomatic";
435 p /= g_get_user_config_dir ();
439 boost::system::error_code ec;
440 if (create_directories) {
441 boost::filesystem::create_directories (p, ec);
447 /** @return Singleton instance */
451 if (_instance == 0) {
452 _instance = new Config;
459 /** Write our configuration to disk */
461 Config::write () const
468 Config::write_config () const
471 xmlpp::Element* root = doc.create_root_node ("Config");
473 /* [XML] Version The version number of the configuration file format; currently 2. */
474 root->add_child("Version")->add_child_text ("2");
475 /* [XML] MasterEncodingThreads Number of encoding threads to use when running as master. */
476 root->add_child("MasterEncodingThreads")->add_child_text (raw_convert<string> (_master_encoding_threads));
477 /* [XML] ServerEncodingThreads Number of encoding threads to use when running as server. */
478 root->add_child("ServerEncodingThreads")->add_child_text (raw_convert<string> (_server_encoding_threads));
479 if (_default_directory) {
480 /* [XML:opt] DefaultDirectory Default directory when creating a new film in the GUI. */
481 root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ());
483 /* [XML] ServerPortBase Port number to use for frame encoding requests. <code>ServerPortBase</code> + 1 and
484 <code>ServerPortBase</code> + 2 are used for querying servers. <code>ServerPortBase</code> + 3 is used
485 by the batch converter to listen for job requests.
487 root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
488 /* [XML] UseAnyServers 1 to broadcast to look for encoding servers to use, 0 to use only those configured. */
489 root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
491 BOOST_FOREACH (string i, _servers) {
492 /* [XML:opt] Server IP address or hostname of an encoding server to use; you can use as many of these tags
495 root->add_child("Server")->add_child_text (i);
498 /* [XML] OnlyServersEncode 1 to set the master to do decoding of source content no JPEG2000 encoding; all encoding
499 is done by the encoding servers. 0 to set the master to do some encoding as well as coordinating the job.
501 root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
502 /* [XML] TMSProtocol Protocol to use to copy files to a TMS; 0 to use SCP, 1 for FTP. */
503 root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
504 /* [XML] TMSIP IP address of TMS */
505 root->add_child("TMSIP")->add_child_text (_tms_ip);
506 /* [XML] TMSPath Path on the TMS to copy files to */
507 root->add_child("TMSPath")->add_child_text (_tms_path);
508 /* [XML] TMSUser Username to log into the TMS with */
509 root->add_child("TMSUser")->add_child_text (_tms_user);
510 /* [XML] TMSPassword Password to log into the TMS with */
511 root->add_child("TMSPassword")->add_child_text (_tms_password);
512 if (_cinema_sound_processor) {
513 /* [XML:opt] CinemaSoundProcessor Identifier of the type of cinema sound processor to use when calculating
514 gain changes from fader positions. Currently can only be <code>dolby_cp750</code>.
516 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
519 /* [XML:opt] Language Language to use in the GUI e.g. <code>fr_FR</code>. */
520 root->add_child("Language")->add_child_text (_language.get());
522 if (_default_container) {
523 /* [XML:opt] DefaultContainer ID of default container
524 * to use when creating new films (<code>185</code>,<code>239</code> or
527 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
529 if (_default_scale_to) {
530 /* [XML:opt] DefaultScaleTo ID of default ratio to scale content to when creating new films
531 (see <code>DefaultContainer</code> for IDs).
533 root->add_child("DefaultScaleTo")->add_child_text (_default_scale_to->id ());
535 if (_default_dcp_content_type) {
536 /* [XML:opt] DefaultDCPContentType Default content type ot use when creating new films (<code>FTR</code>, <code>SHR</code>,
537 <code>TLR</code>, <code>TST</code>, <code>XSN</code>, <code>RTG</code>, <code>TSR</code>, <code>POL</code>,
538 <code>PSA</code> or <code>ADV</code>). */
539 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
541 /* [XML] DefaultDCPAudioChannels Default number of audio channels to use when creating new films. */
542 root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
543 /* [XML] DCPIssuer Issuer text to write into CPL files. */
544 root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
545 /* [XML] DCPIssuer Creator text to write into CPL files. */
546 root->add_child("DCPCreator")->add_child_text (_dcp_creator);
547 root->add_child("DefaultUploadAfterMakeDCP")->add_child_text (_default_upload_after_make_dcp ? "1" : "0");
549 /* [XML] ISDCFMetadata Default ISDCF metadata to use for new films; child tags are <code><ContentVersion></code>,
550 <code><AudioLanguage></code>, <code><SubtitleLanguage></code>, <code><Territory></code>,
551 <code><Rating></code>, <code><Studio></code>, <code><Facility></code>, <code><TempVersion></code>,
552 <code><PreRelease></code>, <code><RedBand></code>, <code><Chain></code>, <code><TwoDVersionOFThreeD></code>,
553 <code><MasteredLuminance></code>.
555 _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
557 /* [XML] DefaultStillLength Default length (in seconds) for still images in new films. */
558 root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
559 /* [XML] DefaultJ2KBandwidth Default bitrate (in bits per second) for JPEG2000 data in new films. */
560 root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
561 /* [XML] DefaultAudioDelay Default delay to apply to audio (positive moves audio later) in milliseconds. */
562 root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
563 /* [XML] DefaultInterop 1 to default new films to Interop, 0 for SMPTE. */
564 root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
565 if (_default_kdm_directory) {
566 /* [XML:opt] DefaultKDMDirectory Default directory to write KDMs to. */
567 root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ());
569 /* [XML] MailServer Hostname of SMTP server to use. */
570 root->add_child("MailServer")->add_child_text (_mail_server);
571 /* [XML] MailPort Port number to use on SMTP server. */
572 root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
573 /* [XML] MailUser Username to use on SMTP server. */
574 root->add_child("MailUser")->add_child_text (_mail_user);
575 /* [XML] MailPassword Password to use on SMTP server. */
576 root->add_child("MailPassword")->add_child_text (_mail_password);
577 /* [XML] KDMSubject Subject to use for KDM emails. */
578 root->add_child("KDMSubject")->add_child_text (_kdm_subject);
579 /* [XML] KDMFrom From address to use for KDM emails. */
580 root->add_child("KDMFrom")->add_child_text (_kdm_from);
581 BOOST_FOREACH (string i, _kdm_cc) {
582 /* [XML] KDMCC CC address to use for KDM emails; you can use as many of these tags as you like. */
583 root->add_child("KDMCC")->add_child_text (i);
585 /* [XML] KDMBCC BCC address to use for KDM emails */
586 root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
587 /* [XML] KDMEmail Text of KDM email */
588 root->add_child("KDMEmail")->add_child_text (_kdm_email);
590 /* [XML] CheckForUpdates 1 to check dcpomatic.com for new versions, 0 to check only on request */
591 root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
592 /* [XML] CheckForUpdates 1 to check dcpomatic.com for new text versions, 0 to check only on request */
593 root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
595 /* [XML] MaximumJ2KBandwidth Maximum J2K bandwidth (in bits per second) that can be specified in the GUI */
596 root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
597 /* [XML] AllowAnyDCPFrameRate 1 to allow users to specify any frame rate when creating DCPs, 0 to limit the GUI to standard rates */
598 root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
599 /* [XML] LogTypes Types of logging to write; a bitfield where 1 is general notes, 2 warnings, 4 errors, 8 debug information related
600 to encoding, 16 debug information related to encoding, 32 debug information for timing purposes, 64 debug information related
603 root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
604 /* [XML] AnalyseEBUR128 1 to do EBUR128 analyses when analysing audio, otherwise 0. */
605 root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
606 /* [XML] AutomaticAudioAnalysis 1 to run audio analysis automatically when audio content is added to the film, otherwise 0. */
607 root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
608 #ifdef DCPOMATIC_WINDOWS
609 /* [XML] Win32Console 1 to open a console when running on Windows, otherwise 0. */
610 root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
613 /* [XML] Signer Certificate chain and private key to use when signing DCPs and KDMs. Should contain <code><Certificate></code>
614 tags in order and a <code><PrivateKey></code> tag all containing PEM-encoded certificates or private keys as appropriate.
616 xmlpp::Element* signer = root->add_child ("Signer");
617 DCPOMATIC_ASSERT (_signer_chain);
618 BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->unordered()) {
619 signer->add_child("Certificate")->add_child_text (i.certificate (true));
621 signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
623 /* [XML] Decryption Certificate chain and private key to use when decrypting KDMs */
624 xmlpp::Element* decryption = root->add_child ("Decryption");
625 DCPOMATIC_ASSERT (_decryption_chain);
626 BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->unordered()) {
627 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
629 decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
631 /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the GUI; there can be more than one
634 BOOST_FOREACH (boost::filesystem::path i, _history) {
635 root->add_child("History")->add_child_text (i.string ());
638 BOOST_FOREACH (boost::filesystem::path i, _player_history) {
639 root->add_child("PlayerHistory")->add_child_text (i.string ());
642 /* [XML] DKDMGroup A group of DKDMs, each with a <code>Name</code> attribute, containing other <code><DKDMGroup></code>
643 or <code><DKDM></code> tags.
645 /* [XML] DKDM A DKDM as XML */
646 _dkdms->as_xml (root);
648 /* [XML] CinemasFile Filename of cinemas list file */
649 root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
650 /* [XML] ShowHintsBeforeMakeDCP 1 to show hints in the GUI before making a DCP, otherwise 0 */
651 root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
652 /* [XML] ConfirmKDMEmail 1 to confirm before sending KDM emails in the GUI, otherwise 0 */
653 root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0");
654 /* [XML] KDMFilenameFormat Format for KDM filenames */
655 root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
656 /* [XML] KDMContainerNameFormat Format for KDM containers (directories or ZIP files) */
657 root->add_child("KDMContainerNameFormat")->add_child_text (_kdm_container_name_format.specification ());
658 /* [XML] DCPMetadataFilenameFormat Format for DCP metadata filenames */
659 root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ());
660 /* [XML] DCPAssetFilenameFormat Format for DCP asset filenames */
661 root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ());
662 /* [XML] JumpToSelected 1 to make the GUI jump to the start of content when it is selected, otherwise 0 */
663 root->add_child("JumpToSelected")->add_child_text (_jump_to_selected ? "1" : "0");
664 /* [XML] Nagged 1 if a particular nag screen has been shown and should not be shown again, otherwise 0 */
665 for (int i = 0; i < NAG_COUNT; ++i) {
666 xmlpp::Element* e = root->add_child ("Nagged");
667 e->set_attribute ("Id", raw_convert<string>(i));
668 e->add_child_text (_nagged[i] ? "1" : "0");
670 /* [XML] PreviewSound 1 to use sound in the GUI preview and player, otherwise 0 */
671 root->add_child("PreviewSound")->add_child_text (_sound ? "1" : "0");
673 /* [XML:opt] PreviewSoundOutput Name of the audio output to use */
674 root->add_child("PreviewSoundOutput")->add_child_text (_sound_output.get());
676 /* [XML] CoverSheet Text of the cover sheet to write when making DCPs */
677 root->add_child("CoverSheet")->add_child_text (_cover_sheet);
678 if (_last_player_load_directory) {
679 root->add_child("LastPlayerLoadDirectory")->add_child_text(_last_player_load_directory->string());
681 if (_last_kdm_write_type) {
682 switch (_last_kdm_write_type.get()) {
684 root->add_child("LastKDMWriteType")->add_child_text("flat");
686 case KDM_WRITE_FOLDER:
687 root->add_child("LastKDMWriteType")->add_child_text("folder");
690 root->add_child("LastKDMWriteType")->add_child_text("zip");
694 /* [XML] FramesInMemoryMultiplier value to multiply the encoding threads count by to get the maximum number of
695 frames to be held in memory at once.
697 root->add_child("FramesInMemoryMultiplier")->add_child_text(raw_convert<string>(_frames_in_memory_multiplier));
700 doc.write_to_file_formatted(config_file().string());
701 } catch (xmlpp::exception& e) {
702 string s = e.what ();
704 throw FileError (s, path("config.xml"));
709 Config::write_cinemas () const
712 xmlpp::Element* root = doc.create_root_node ("Cinemas");
713 root->add_child("Version")->add_child_text ("1");
715 BOOST_FOREACH (shared_ptr<Cinema> i, _cinemas) {
716 i->as_xml (root->add_child ("Cinema"));
720 doc.write_to_file_formatted (_cinemas_file.string ());
721 } catch (xmlpp::exception& e) {
722 string s = e.what ();
724 throw FileError (s, _cinemas_file);
728 boost::filesystem::path
729 Config::default_directory_or (boost::filesystem::path a) const
731 return directory_or (_default_directory, a);
734 boost::filesystem::path
735 Config::default_kdm_directory_or (boost::filesystem::path a) const
737 return directory_or (_default_kdm_directory, a);
740 boost::filesystem::path
741 Config::directory_or (optional<boost::filesystem::path> dir, boost::filesystem::path a) const
747 boost::system::error_code ec;
748 bool const e = boost::filesystem::exists (*dir, ec);
764 Config::changed (Property what)
770 Config::set_kdm_email_to_default ()
772 _kdm_subject = _("KDM delivery: $CPL_NAME");
775 "Dear Projectionist\n\n"
776 "Please find attached KDMs for $CPL_NAME.\n\n"
777 "Cinema: $CINEMA_NAME\n"
778 "Screen(s): $SCREENS\n\n"
779 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
780 "Best regards,\nDCP-o-matic"
785 Config::reset_kdm_email ()
787 set_kdm_email_to_default ();
792 Config::set_cover_sheet_to_default ()
797 "Format: $CONTAINER\n"
799 "Audio Language: $AUDIO_LANGUAGE\n"
800 "Subtitle Language: $SUBTITLE_LANGUAGE\n"
807 Config::add_to_history (boost::filesystem::path p)
809 add_to_history_internal (_history, p);
813 Config::add_to_player_history (boost::filesystem::path p)
815 add_to_history_internal (_player_history, p);
819 Config::add_to_history_internal (vector<boost::filesystem::path>& h, boost::filesystem::path p)
821 /* Remove existing instances of this path in the history */
822 h.erase (remove (h.begin(), h.end(), p), h.end ());
824 h.insert (h.begin (), p);
825 if (h.size() > HISTORY_SIZE) {
833 Config::have_existing (string file)
835 return boost::filesystem::exists (path (file, false));
839 Config::read_cinemas (cxml::Document const & f)
842 list<cxml::NodePtr> cin = f.node_children ("Cinema");
843 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Cinema")) {
844 /* Slightly grotty two-part construction of Cinema here so that we can use
847 shared_ptr<Cinema> cinema (new Cinema (i));
848 cinema->read_screens (i);
849 _cinemas.push_back (cinema);
854 Config::set_cinemas_file (boost::filesystem::path file)
856 _cinemas_file = file;
858 if (boost::filesystem::exists (_cinemas_file)) {
859 /* Existing file; read it in */
860 cxml::Document f ("Cinemas");
861 f.read_file (_cinemas_file);
869 Config::save_template (shared_ptr<const Film> film, string name) const
871 film->write_template (template_path (name));
875 Config::templates () const
877 if (!boost::filesystem::exists (path ("templates"))) {
878 return list<string> ();
882 for (boost::filesystem::directory_iterator i (path("templates")); i != boost::filesystem::directory_iterator(); ++i) {
883 n.push_back (i->path().filename().string());
889 Config::existing_template (string name) const
891 return boost::filesystem::exists (template_path (name));
894 boost::filesystem::path
895 Config::template_path (string name) const
897 return path("templates") / tidy_for_filename (name);
901 Config::rename_template (string old_name, string new_name) const
903 boost::filesystem::rename (template_path (old_name), template_path (new_name));
907 Config::delete_template (string name) const
909 boost::filesystem::remove (template_path (name));
912 /** @return Path to the config.xml containing the actual settings, following a link if required */
913 boost::filesystem::path
914 Config::config_file ()
916 cxml::Document f ("Config");
917 boost::filesystem::path main = path("config.xml", false);
918 if (!boost::filesystem::exists (main)) {
919 /* It doesn't exist, so there can't be any links; just return it */
923 /* See if there's a link */
925 optional<string> link = f.optional_string_child("Link");
934 Config::reset_cover_sheet ()
936 set_cover_sheet_to_default ();
941 Config::link (boost::filesystem::path new_file) const
944 doc.create_root_node("Config")->add_child("Link")->add_child_text(new_file.string());
946 doc.write_to_file_formatted(path("config.xml", true).string());
947 } catch (xmlpp::exception& e) {
948 string s = e.what ();
950 throw FileError (s, path("config.xml"));
955 Config::copy_and_link (boost::filesystem::path new_file) const
958 boost::filesystem::copy_file (config_file(), new_file, boost::filesystem::copy_option::overwrite_if_exists);