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 _allow_any_container = false;
98 _language = optional<string> ();
99 _default_still_length = 10;
100 _default_container = Ratio::from_id ("185");
101 _default_scale_to = 0;
102 _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
103 _default_dcp_audio_channels = 6;
104 _default_j2k_bandwidth = 100000000;
105 _default_audio_delay = 0;
106 _default_interop = true;
107 _default_upload_after_make_dcp = false;
115 _notification_from = "";
116 _notification_to = "";
117 _notification_cc.clear ();
118 _notification_bcc = "";
119 _check_for_updates = false;
120 _check_for_test_updates = false;
121 _maximum_j2k_bandwidth = 250000000;
122 _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR;
123 _analyse_ebur128 = true;
124 _automatic_audio_analysis = false;
125 #ifdef DCPOMATIC_WINDOWS
126 _win32_console = false;
128 _cinemas_file = path ("cinemas.xml");
129 _show_hints_before_make_dcp = true;
130 _confirm_kdm_email = true;
131 _kdm_container_name_format = dcp::NameFormat ("KDM %f %c");
132 _kdm_filename_format = dcp::NameFormat ("KDM %f %c %s");
133 _dcp_metadata_filename_format = dcp::NameFormat ("%t");
134 _dcp_asset_filename_format = dcp::NameFormat ("%t");
135 _jump_to_selected = true;
136 for (int i = 0; i < NAG_COUNT; ++i) {
140 _sound_output = optional<string> ();
141 _last_kdm_write_type = KDM_WRITE_FLAT;
142 _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
144 /* I think the scaling factor here should be the ratio of the longest frame
145 encode time to the shortest; if the thread count is T, longest time is L
146 and the shortest time S we could encode L/S frames per thread whilst waiting
147 for the L frame to encode so we might have to store LT/S frames.
149 However we don't want to use too much memory, so keep it a bit lower than we'd
150 perhaps like. A J2K frame is typically about 1Mb so 3 here will mean we could
151 use about 240Mb with 72 encoding threads.
153 _frames_in_memory_multiplier = 3;
154 _decode_reduction = optional<int>();
155 _default_notify = false;
156 for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
157 _notification[i] = false;
159 _barco_username = optional<string>();
160 _barco_password = optional<string>();
161 _christie_username = optional<string>();
162 _christie_password = optional<string>();
163 _gdc_username = optional<string>();
164 _gdc_password = optional<string>();
165 _interface_complexity = INTERFACE_SIMPLE;
166 _player_mode = PLAYER_MODE_WINDOW;
168 _allowed_dcp_frame_rates.clear ();
169 _allowed_dcp_frame_rates.push_back (24);
170 _allowed_dcp_frame_rates.push_back (25);
171 _allowed_dcp_frame_rates.push_back (30);
172 _allowed_dcp_frame_rates.push_back (48);
173 _allowed_dcp_frame_rates.push_back (50);
174 _allowed_dcp_frame_rates.push_back (60);
176 set_kdm_email_to_default ();
177 set_notification_email_to_default ();
178 set_cover_sheet_to_default ();
182 Config::restore_defaults ()
184 Config::instance()->set_defaults ();
185 Config::instance()->changed ();
188 shared_ptr<dcp::CertificateChain>
189 Config::create_certificate_chain ()
191 return shared_ptr<dcp::CertificateChain> (
192 new dcp::CertificateChain (
196 ".dcpomatic.smpte-430-2.ROOT",
197 ".dcpomatic.smpte-430-2.INTERMEDIATE",
198 "CS.dcpomatic.smpte-430-2.LEAF"
206 /* Make a copy of the configuration */
209 while (n < 100 && boost::filesystem::exists(path(String::compose("config.xml.%1", n)))) {
213 boost::filesystem::copy_file(path("config.xml", false), path(String::compose("config.xml.%1", n), false));
214 boost::filesystem::copy_file(path("cinemas.xml", false), path(String::compose("cinemas.xml.%1", n), false));
222 cxml::Document f ("Config");
223 f.read_file (config_file ());
225 optional<int> version = f.optional_number_child<int> ("Version");
226 if (version && *version < _current_version) {
227 /* Back up the old config before we re-write it in a back-incompatible way */
231 if (f.optional_number_child<int>("NumLocalEncodingThreads")) {
232 _master_encoding_threads = _server_encoding_threads = f.optional_number_child<int>("NumLocalEncodingThreads").get();
234 _master_encoding_threads = f.number_child<int>("MasterEncodingThreads");
235 _server_encoding_threads = f.number_child<int>("ServerEncodingThreads");
238 _default_directory = f.optional_string_child ("DefaultDirectory");
239 if (_default_directory && _default_directory->empty ()) {
240 /* We used to store an empty value for this to mean "none set" */
241 _default_directory = boost::optional<boost::filesystem::path> ();
244 boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
246 b = f.optional_number_child<int> ("ServerPortBase");
248 _server_port_base = b.get ();
250 boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
251 _use_any_servers = u.get_value_or (true);
253 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Server")) {
254 if (i->node_children("HostName").size() == 1) {
255 _servers.push_back (i->string_child ("HostName"));
257 _servers.push_back (i->content ());
261 _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
262 _tms_protocol = static_cast<Protocol> (f.optional_number_child<int> ("TMSProtocol").get_value_or (static_cast<int> (PROTOCOL_SCP)));
263 _tms_ip = f.string_child ("TMSIP");
264 _tms_path = f.string_child ("TMSPath");
265 _tms_user = f.string_child ("TMSUser");
266 _tms_password = f.string_child ("TMSPassword");
269 c = f.optional_string_child ("SoundProcessor");
271 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
273 c = f.optional_string_child ("CinemaSoundProcessor");
275 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
278 _language = f.optional_string_child ("Language");
280 c = f.optional_string_child ("DefaultContainer");
282 _default_container = Ratio::from_id (c.get ());
285 if (_default_container && !_default_container->used_for_container()) {
286 Warning (_("Your default container is not valid and has been changed to Flat (1.85:1)"));
287 _default_container = Ratio::from_id ("185");
290 c = f.optional_string_child ("DefaultScaleTo");
292 _default_scale_to = Ratio::from_id (c.get ());
295 _default_dcp_content_type = DCPContentType::from_isdcf_name(f.optional_string_child("DefaultDCPContentType").get_value_or("FTR"));
296 _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
298 if (f.optional_string_child ("DCPMetadataIssuer")) {
299 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
300 } else if (f.optional_string_child ("DCPIssuer")) {
301 _dcp_issuer = f.string_child ("DCPIssuer");
304 _default_upload_after_make_dcp = f.optional_bool_child("DefaultUploadAfterMakeDCP").get_value_or (false);
305 _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
307 if (version && version.get() >= 2) {
308 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
310 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
313 _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
314 _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
315 _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
316 _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
317 _default_kdm_directory = f.optional_string_child("DefaultKDMDirectory");
319 /* Load any cinemas from config.xml */
322 _mail_server = f.string_child ("MailServer");
323 _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
324 _mail_user = f.optional_string_child("MailUser").get_value_or ("");
325 _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
327 _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
328 _kdm_from = f.string_child ("KDMFrom");
329 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("KDMCC")) {
330 if (!i->content().empty()) {
331 _kdm_cc.push_back (i->content ());
334 _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
335 _kdm_email = f.string_child ("KDMEmail");
337 _notification_subject = f.optional_string_child("NotificationSubject").get_value_or(_("DCP-o-matic notification"));
338 _notification_from = f.optional_string_child("NotificationFrom").get_value_or("");
339 _notification_to = f.optional_string_child("NotificationTo").get_value_or("");
340 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("NotificationCC")) {
341 if (!i->content().empty()) {
342 _notification_cc.push_back (i->content ());
345 _notification_bcc = f.optional_string_child("NotificationBCC").get_value_or("");
346 if (f.optional_string_child("NotificationEmail")) {
347 _notification_email = f.string_child("NotificationEmail");
350 _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
351 _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
353 _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
354 _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
355 _allow_any_container = f.optional_bool_child ("AllowAnyContainer").get_value_or (false);
357 _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
358 _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
359 _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
360 #ifdef DCPOMATIC_WINDOWS
361 _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
364 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("History")) {
365 _history.push_back (i->content ());
368 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("PlayerHistory")) {
369 _player_history.push_back (i->content ());
372 cxml::NodePtr signer = f.optional_node_child ("Signer");
374 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
375 /* Read the signing certificates and private key in from the config file */
376 BOOST_FOREACH (cxml::NodePtr i, signer->node_children ("Certificate")) {
377 c->add (dcp::Certificate (i->content ()));
379 c->set_key (signer->string_child ("PrivateKey"));
382 /* Make a new set of signing certificates and key */
383 _signer_chain = create_certificate_chain ();
386 /* These must be done before we call BadSignerChain as that might set one
389 BOOST_FOREACH (cxml::NodePtr i, f.node_children("Nagged")) {
390 int const id = i->number_attribute<int>("Id");
391 if (id >= 0 && id < NAG_COUNT) {
392 _nagged[id] = raw_convert<int>(i->content());
396 bool bad_signer_chain = false;
397 BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->unordered()) {
398 if (i.has_utf8_strings()) {
399 bad_signer_chain = true;
403 if (bad_signer_chain) {
404 optional<bool> const remake = BadSignerChain();
405 if (remake && *remake) {
406 _signer_chain = create_certificate_chain ();
410 cxml::NodePtr decryption = f.optional_node_child ("Decryption");
412 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
413 BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) {
414 c->add (dcp::Certificate (i->content ()));
416 c->set_key (decryption->string_child ("PrivateKey"));
417 _decryption_chain = c;
419 _decryption_chain = create_certificate_chain ();
422 if (f.optional_node_child("DKDMGroup")) {
423 /* New-style: all DKDMs in a group */
424 _dkdms = dynamic_pointer_cast<DKDMGroup> (DKDMBase::read (f.node_child("DKDMGroup")));
426 /* Old-style: one or more DKDM nodes */
427 _dkdms.reset (new DKDMGroup ("root"));
428 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("DKDM")) {
429 _dkdms->add (DKDMBase::read (i));
432 _cinemas_file = f.optional_string_child("CinemasFile").get_value_or (path ("cinemas.xml").string ());
433 _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
434 _confirm_kdm_email = f.optional_bool_child("ConfirmKDMEmail").get_value_or (true);
435 _kdm_container_name_format = dcp::NameFormat (f.optional_string_child("KDMContainerNameFormat").get_value_or ("KDM %f %c"));
436 _kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
437 _dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t"));
438 _dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t"));
439 _jump_to_selected = f.optional_bool_child("JumpToSelected").get_value_or (true);
440 /* The variable was renamed but not the XML tag */
441 _sound = f.optional_bool_child("PreviewSound").get_value_or (true);
442 _sound_output = f.optional_string_child("PreviewSoundOutput");
443 if (f.optional_string_child("CoverSheet")) {
444 _cover_sheet = f.optional_string_child("CoverSheet").get();
446 _last_player_load_directory = f.optional_string_child("LastPlayerLoadDirectory");
447 if (f.optional_string_child("LastKDMWriteType")) {
448 if (f.optional_string_child("LastKDMWriteType").get() == "flat") {
449 _last_kdm_write_type = KDM_WRITE_FLAT;
450 } else if (f.optional_string_child("LastKDMWriteType").get() == "folder") {
451 _last_kdm_write_type = KDM_WRITE_FOLDER;
452 } else if (f.optional_string_child("LastKDMWriteType").get() == "zip") {
453 _last_kdm_write_type = KDM_WRITE_ZIP;
456 if (f.optional_string_child("LastDKDMWriteType")) {
457 if (f.optional_string_child("LastDKDMWriteType").get() == "internal") {
458 _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
459 } else if (f.optional_string_child("LastDKDMWriteType").get() == "file") {
460 _last_dkdm_write_type = DKDM_WRITE_FILE;
463 _frames_in_memory_multiplier = f.optional_number_child<int>("FramesInMemoryMultiplier").get_value_or(3);
464 _decode_reduction = f.optional_number_child<int>("DecodeReduction");
465 _default_notify = f.optional_bool_child("DefaultNotify").get_value_or(false);
467 BOOST_FOREACH (cxml::NodePtr i, f.node_children("Notification")) {
468 int const id = i->number_attribute<int>("Id");
469 if (id >= 0 && id < NOTIFICATION_COUNT) {
470 _notification[id] = raw_convert<int>(i->content());
474 _barco_username = f.optional_string_child("BarcoUsername");
475 _barco_password = f.optional_string_child("BarcoPassword");
476 _christie_username = f.optional_string_child("ChristieUsername");
477 _christie_password = f.optional_string_child("ChristiePassword");
478 _gdc_username = f.optional_string_child("GDCUsername");
479 _gdc_password = f.optional_string_child("GDCPassword");
481 optional<string> ic = f.optional_string_child("InterfaceComplexity");
482 if (ic && *ic == "full") {
483 _interface_complexity = INTERFACE_FULL;
485 optional<string> pm = f.optional_string_child("PlayerMode");
486 if (pm && *pm == "window") {
487 _player_mode = PLAYER_MODE_WINDOW;
488 } else if (pm && *pm == "full") {
489 _player_mode = PLAYER_MODE_FULL;
490 } else if (pm && *pm == "dual") {
491 _player_mode = PLAYER_MODE_DUAL;
494 /* Replace any cinemas from config.xml with those from the configured file */
495 if (boost::filesystem::exists (_cinemas_file)) {
496 cxml::Document f ("Cinemas");
497 f.read_file (_cinemas_file);
502 if (have_existing ("config.xml")) {
504 /* We have a config file but it didn't load */
508 /* Make a new set of signing certificates and key */
509 _signer_chain = create_certificate_chain ();
510 /* And similar for decryption of KDMs */
511 _decryption_chain = create_certificate_chain ();
515 /** @return Filename to write configuration to */
516 boost::filesystem::path
517 Config::path (string file, bool create_directories)
519 boost::filesystem::path p;
524 p /= g_get_home_dir ();
527 p /= "com.dcpomatic";
530 p /= g_get_user_config_dir ();
534 boost::system::error_code ec;
535 if (create_directories) {
536 boost::filesystem::create_directories (p, ec);
542 /** @return Singleton instance */
546 if (_instance == 0) {
547 _instance = new Config;
554 /** Write our configuration to disk */
556 Config::write () const
563 Config::write_config () const
566 xmlpp::Element* root = doc.create_root_node ("Config");
568 /* [XML] Version The version number of the configuration file format */
569 root->add_child("Version")->add_child_text (String::compose ("%1", _current_version));
570 /* [XML] MasterEncodingThreads Number of encoding threads to use when running as master. */
571 root->add_child("MasterEncodingThreads")->add_child_text (raw_convert<string> (_master_encoding_threads));
572 /* [XML] ServerEncodingThreads Number of encoding threads to use when running as server. */
573 root->add_child("ServerEncodingThreads")->add_child_text (raw_convert<string> (_server_encoding_threads));
574 if (_default_directory) {
575 /* [XML:opt] DefaultDirectory Default directory when creating a new film in the GUI. */
576 root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ());
578 /* [XML] ServerPortBase Port number to use for frame encoding requests. <code>ServerPortBase</code> + 1 and
579 <code>ServerPortBase</code> + 2 are used for querying servers. <code>ServerPortBase</code> + 3 is used
580 by the batch converter to listen for job requests.
582 root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
583 /* [XML] UseAnyServers 1 to broadcast to look for encoding servers to use, 0 to use only those configured. */
584 root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
586 BOOST_FOREACH (string i, _servers) {
587 /* [XML:opt] Server IP address or hostname of an encoding server to use; you can use as many of these tags
590 root->add_child("Server")->add_child_text (i);
593 /* [XML] OnlyServersEncode 1 to set the master to do decoding of source content no JPEG2000 encoding; all encoding
594 is done by the encoding servers. 0 to set the master to do some encoding as well as coordinating the job.
596 root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
597 /* [XML] TMSProtocol Protocol to use to copy files to a TMS; 0 to use SCP, 1 for FTP. */
598 root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
599 /* [XML] TMSIP IP address of TMS */
600 root->add_child("TMSIP")->add_child_text (_tms_ip);
601 /* [XML] TMSPath Path on the TMS to copy files to */
602 root->add_child("TMSPath")->add_child_text (_tms_path);
603 /* [XML] TMSUser Username to log into the TMS with */
604 root->add_child("TMSUser")->add_child_text (_tms_user);
605 /* [XML] TMSPassword Password to log into the TMS with */
606 root->add_child("TMSPassword")->add_child_text (_tms_password);
607 if (_cinema_sound_processor) {
608 /* [XML:opt] CinemaSoundProcessor Identifier of the type of cinema sound processor to use when calculating
609 gain changes from fader positions. Currently can only be <code>dolby_cp750</code>.
611 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
614 /* [XML:opt] Language Language to use in the GUI e.g. <code>fr_FR</code>. */
615 root->add_child("Language")->add_child_text (_language.get());
617 if (_default_container) {
618 /* [XML:opt] DefaultContainer ID of default container
619 * to use when creating new films (<code>185</code>,<code>239</code> or
622 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
624 if (_default_scale_to) {
625 /* [XML:opt] DefaultScaleTo ID of default ratio to scale content to when creating new films
626 (see <code>DefaultContainer</code> for IDs).
628 root->add_child("DefaultScaleTo")->add_child_text (_default_scale_to->id ());
630 if (_default_dcp_content_type) {
631 /* [XML:opt] DefaultDCPContentType Default content type ot use when creating new films (<code>FTR</code>, <code>SHR</code>,
632 <code>TLR</code>, <code>TST</code>, <code>XSN</code>, <code>RTG</code>, <code>TSR</code>, <code>POL</code>,
633 <code>PSA</code> or <code>ADV</code>). */
634 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
636 /* [XML] DefaultDCPAudioChannels Default number of audio channels to use when creating new films. */
637 root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
638 /* [XML] DCPIssuer Issuer text to write into CPL files. */
639 root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
640 /* [XML] DCPIssuer Creator text to write into CPL files. */
641 root->add_child("DCPCreator")->add_child_text (_dcp_creator);
642 root->add_child("DefaultUploadAfterMakeDCP")->add_child_text (_default_upload_after_make_dcp ? "1" : "0");
644 /* [XML] ISDCFMetadata Default ISDCF metadata to use for new films; child tags are <code><ContentVersion></code>,
645 <code><AudioLanguage></code>, <code><SubtitleLanguage></code>, <code><Territory></code>,
646 <code><Rating></code>, <code><Studio></code>, <code><Facility></code>, <code><TempVersion></code>,
647 <code><PreRelease></code>, <code><RedBand></code>, <code><Chain></code>, <code><TwoDVersionOFThreeD></code>,
648 <code><MasteredLuminance></code>.
650 _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
652 /* [XML] DefaultStillLength Default length (in seconds) for still images in new films. */
653 root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
654 /* [XML] DefaultJ2KBandwidth Default bitrate (in bits per second) for JPEG2000 data in new films. */
655 root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
656 /* [XML] DefaultAudioDelay Default delay to apply to audio (positive moves audio later) in milliseconds. */
657 root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
658 /* [XML] DefaultInterop 1 to default new films to Interop, 0 for SMPTE. */
659 root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
660 if (_default_kdm_directory) {
661 /* [XML:opt] DefaultKDMDirectory Default directory to write KDMs to. */
662 root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ());
664 /* [XML] MailServer Hostname of SMTP server to use. */
665 root->add_child("MailServer")->add_child_text (_mail_server);
666 /* [XML] MailPort Port number to use on SMTP server. */
667 root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
668 /* [XML] MailUser Username to use on SMTP server. */
669 root->add_child("MailUser")->add_child_text (_mail_user);
670 /* [XML] MailPassword Password to use on SMTP server. */
671 root->add_child("MailPassword")->add_child_text (_mail_password);
673 /* [XML] KDMSubject Subject to use for KDM emails. */
674 root->add_child("KDMSubject")->add_child_text (_kdm_subject);
675 /* [XML] KDMFrom From address to use for KDM emails. */
676 root->add_child("KDMFrom")->add_child_text (_kdm_from);
677 BOOST_FOREACH (string i, _kdm_cc) {
678 /* [XML] KDMCC CC address to use for KDM emails; you can use as many of these tags as you like. */
679 root->add_child("KDMCC")->add_child_text (i);
681 /* [XML] KDMBCC BCC address to use for KDM emails */
682 root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
683 /* [XML] KDMEmail Text of KDM email */
684 root->add_child("KDMEmail")->add_child_text (_kdm_email);
686 /* [XML] NotificationSubject Subject to use for Notification emails. */
687 root->add_child("NotificationSubject")->add_child_text (_notification_subject);
688 /* [XML] NotificationFrom From address to use for Notification emails. */
689 root->add_child("NotificationFrom")->add_child_text (_notification_from);
690 /* [XML] NotificationFrom To address to use for Notification emails. */
691 root->add_child("NotificationTo")->add_child_text (_notification_to);
692 BOOST_FOREACH (string i, _notification_cc) {
693 /* [XML] NotificationCC CC address to use for Notification emails; you can use as many of these tags as you like. */
694 root->add_child("NotificationCC")->add_child_text (i);
696 /* [XML] NotificationBCC BCC address to use for Notification emails */
697 root->add_child("NotificationBCC")->add_child_text (_notification_bcc);
698 /* [XML] NotificationEmail Text of Notification email */
699 root->add_child("NotificationEmail")->add_child_text (_notification_email);
701 /* [XML] CheckForUpdates 1 to check dcpomatic.com for new versions, 0 to check only on request */
702 root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
703 /* [XML] CheckForUpdates 1 to check dcpomatic.com for new text versions, 0 to check only on request */
704 root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
706 /* [XML] MaximumJ2KBandwidth Maximum J2K bandwidth (in bits per second) that can be specified in the GUI */
707 root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
708 /* [XML] AllowAnyDCPFrameRate 1 to allow users to specify any frame rate when creating DCPs, 0 to limit the GUI to standard rates */
709 root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
710 /* [XML] AllowAnyContainer 1 to allow users to user any container ratio for their DCP, 0 to limit the GUI to standard containers */
711 root->add_child("AllowAnyContainer")->add_child_text (_allow_any_container ? "1" : "0");
712 /* [XML] LogTypes Types of logging to write; a bitfield where 1 is general notes, 2 warnings, 4 errors, 8 debug information related
713 to encoding, 16 debug information related to encoding, 32 debug information for timing purposes, 64 debug information related
716 root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
717 /* [XML] AnalyseEBUR128 1 to do EBUR128 analyses when analysing audio, otherwise 0. */
718 root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
719 /* [XML] AutomaticAudioAnalysis 1 to run audio analysis automatically when audio content is added to the film, otherwise 0. */
720 root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
721 #ifdef DCPOMATIC_WINDOWS
722 /* [XML] Win32Console 1 to open a console when running on Windows, otherwise 0. */
723 root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
726 /* [XML] Signer Certificate chain and private key to use when signing DCPs and KDMs. Should contain <code><Certificate></code>
727 tags in order and a <code><PrivateKey></code> tag all containing PEM-encoded certificates or private keys as appropriate.
729 xmlpp::Element* signer = root->add_child ("Signer");
730 DCPOMATIC_ASSERT (_signer_chain);
731 BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->unordered()) {
732 signer->add_child("Certificate")->add_child_text (i.certificate (true));
734 signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
736 /* [XML] Decryption Certificate chain and private key to use when decrypting KDMs */
737 xmlpp::Element* decryption = root->add_child ("Decryption");
738 DCPOMATIC_ASSERT (_decryption_chain);
739 BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->unordered()) {
740 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
742 decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
744 /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the GUI; there can be more than one
747 BOOST_FOREACH (boost::filesystem::path i, _history) {
748 root->add_child("History")->add_child_text (i.string ());
751 BOOST_FOREACH (boost::filesystem::path i, _player_history) {
752 root->add_child("PlayerHistory")->add_child_text (i.string ());
755 /* [XML] DKDMGroup A group of DKDMs, each with a <code>Name</code> attribute, containing other <code><DKDMGroup></code>
756 or <code><DKDM></code> tags.
758 /* [XML] DKDM A DKDM as XML */
759 _dkdms->as_xml (root);
761 /* [XML] CinemasFile Filename of cinemas list file */
762 root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
763 /* [XML] ShowHintsBeforeMakeDCP 1 to show hints in the GUI before making a DCP, otherwise 0 */
764 root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
765 /* [XML] ConfirmKDMEmail 1 to confirm before sending KDM emails in the GUI, otherwise 0 */
766 root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0");
767 /* [XML] KDMFilenameFormat Format for KDM filenames */
768 root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
769 /* [XML] KDMContainerNameFormat Format for KDM containers (directories or ZIP files) */
770 root->add_child("KDMContainerNameFormat")->add_child_text (_kdm_container_name_format.specification ());
771 /* [XML] DCPMetadataFilenameFormat Format for DCP metadata filenames */
772 root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ());
773 /* [XML] DCPAssetFilenameFormat Format for DCP asset filenames */
774 root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ());
775 /* [XML] JumpToSelected 1 to make the GUI jump to the start of content when it is selected, otherwise 0 */
776 root->add_child("JumpToSelected")->add_child_text (_jump_to_selected ? "1" : "0");
777 /* [XML] Nagged 1 if a particular nag screen has been shown and should not be shown again, otherwise 0 */
778 for (int i = 0; i < NAG_COUNT; ++i) {
779 xmlpp::Element* e = root->add_child ("Nagged");
780 e->set_attribute ("Id", raw_convert<string>(i));
781 e->add_child_text (_nagged[i] ? "1" : "0");
783 /* [XML] PreviewSound 1 to use sound in the GUI preview and player, otherwise 0 */
784 root->add_child("PreviewSound")->add_child_text (_sound ? "1" : "0");
786 /* [XML:opt] PreviewSoundOutput Name of the audio output to use */
787 root->add_child("PreviewSoundOutput")->add_child_text (_sound_output.get());
789 /* [XML] CoverSheet Text of the cover sheet to write when making DCPs */
790 root->add_child("CoverSheet")->add_child_text (_cover_sheet);
791 if (_last_player_load_directory) {
792 root->add_child("LastPlayerLoadDirectory")->add_child_text(_last_player_load_directory->string());
794 if (_last_kdm_write_type) {
795 switch (_last_kdm_write_type.get()) {
797 root->add_child("LastKDMWriteType")->add_child_text("flat");
799 case KDM_WRITE_FOLDER:
800 root->add_child("LastKDMWriteType")->add_child_text("folder");
803 root->add_child("LastKDMWriteType")->add_child_text("zip");
807 if (_last_dkdm_write_type) {
808 switch (_last_dkdm_write_type.get()) {
809 case DKDM_WRITE_INTERNAL:
810 root->add_child("LastDKDMWriteType")->add_child_text("internal");
812 case DKDM_WRITE_FILE:
813 root->add_child("LastDKDMWriteType")->add_child_text("file");
817 /* [XML] FramesInMemoryMultiplier value to multiply the encoding threads count by to get the maximum number of
818 frames to be held in memory at once.
820 root->add_child("FramesInMemoryMultiplier")->add_child_text(raw_convert<string>(_frames_in_memory_multiplier));
822 /* [XML] DecodeReduction power of 2 to reduce DCP images by before decoding in the player */
823 if (_decode_reduction) {
824 root->add_child("DecodeReduction")->add_child_text(raw_convert<string>(_decode_reduction.get()));
827 /* [XML] DefaultNotify 1 to default jobs to notify when complete, otherwise 0 */
828 root->add_child("DefaultNotify")->add_child_text(_default_notify ? "1" : "0");
830 /* [XML] Notification 1 if a notification type is enabled, otherwise 0 */
831 for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
832 xmlpp::Element* e = root->add_child ("Notification");
833 e->set_attribute ("Id", raw_convert<string>(i));
834 e->add_child_text (_notification[i] ? "1" : "0");
837 if (_barco_username) {
838 root->add_child("BarcoUsername")->add_child_text(*_barco_username);
840 if (_barco_password) {
841 root->add_child("BarcoPassword")->add_child_text(*_barco_password);
844 if (_christie_username) {
845 root->add_child("ChristieUsername")->add_child_text(*_christie_username);
847 if (_christie_password) {
848 root->add_child("ChristiePassword")->add_child_text(*_christie_password);
852 root->add_child("GDCUsername")->add_child_text(*_gdc_username);
855 root->add_child("GDCPassword")->add_child_text(*_gdc_password);
858 switch (_interface_complexity) {
859 case INTERFACE_SIMPLE:
860 root->add_child("InterfaceComplexity")->add_child_text("simple");
863 root->add_child("InterfaceComplexity")->add_child_text("full");
867 switch (_player_mode) {
868 case PLAYER_MODE_WINDOW:
869 root->add_child("PlayerMode")->add_child_text("window");
871 case PLAYER_MODE_FULL:
872 root->add_child("PlayerMode")->add_child_text("full");
874 case PLAYER_MODE_DUAL:
875 root->add_child("PlayerMode")->add_child_text("dual");
880 doc.write_to_file_formatted(config_file().string());
881 } catch (xmlpp::exception& e) {
882 string s = e.what ();
884 throw FileError (s, path("config.xml"));
889 Config::write_cinemas () const
892 xmlpp::Element* root = doc.create_root_node ("Cinemas");
893 root->add_child("Version")->add_child_text ("1");
895 BOOST_FOREACH (shared_ptr<Cinema> i, _cinemas) {
896 i->as_xml (root->add_child ("Cinema"));
900 doc.write_to_file_formatted (_cinemas_file.string ());
901 } catch (xmlpp::exception& e) {
902 string s = e.what ();
904 throw FileError (s, _cinemas_file);
908 boost::filesystem::path
909 Config::default_directory_or (boost::filesystem::path a) const
911 return directory_or (_default_directory, a);
914 boost::filesystem::path
915 Config::default_kdm_directory_or (boost::filesystem::path a) const
917 return directory_or (_default_kdm_directory, a);
920 boost::filesystem::path
921 Config::directory_or (optional<boost::filesystem::path> dir, boost::filesystem::path a) const
927 boost::system::error_code ec;
928 bool const e = boost::filesystem::exists (*dir, ec);
944 Config::changed (Property what)
950 Config::set_kdm_email_to_default ()
952 _kdm_subject = _("KDM delivery: $CPL_NAME");
955 "Dear Projectionist\n\n"
956 "Please find attached KDMs for $CPL_NAME.\n\n"
957 "Cinema: $CINEMA_NAME\n"
958 "Screen(s): $SCREENS\n\n"
959 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
960 "Best regards,\nDCP-o-matic"
965 Config::set_notification_email_to_default ()
967 _notification_subject = _("DCP-o-matic notification");
969 _notification_email = _(
970 "$JOB_NAME: $JOB_STATUS"
975 Config::reset_kdm_email ()
977 set_kdm_email_to_default ();
982 Config::reset_notification_email ()
984 set_notification_email_to_default ();
989 Config::set_cover_sheet_to_default ()
994 "Format: $CONTAINER\n"
996 "Audio Language: $AUDIO_LANGUAGE\n"
997 "Subtitle Language: $SUBTITLE_LANGUAGE\n"
1004 Config::add_to_history (boost::filesystem::path p)
1006 add_to_history_internal (_history, p);
1010 Config::add_to_player_history (boost::filesystem::path p)
1012 add_to_history_internal (_player_history, p);
1016 Config::add_to_history_internal (vector<boost::filesystem::path>& h, boost::filesystem::path p)
1018 /* Remove existing instances of this path in the history */
1019 h.erase (remove (h.begin(), h.end(), p), h.end ());
1021 h.insert (h.begin (), p);
1022 if (h.size() > HISTORY_SIZE) {
1030 Config::have_existing (string file)
1032 return boost::filesystem::exists (path (file, false));
1036 Config::read_cinemas (cxml::Document const & f)
1039 list<cxml::NodePtr> cin = f.node_children ("Cinema");
1040 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Cinema")) {
1041 /* Slightly grotty two-part construction of Cinema here so that we can use
1044 shared_ptr<Cinema> cinema (new Cinema (i));
1045 cinema->read_screens (i);
1046 _cinemas.push_back (cinema);
1051 Config::set_cinemas_file (boost::filesystem::path file)
1053 if (file == _cinemas_file) {
1057 _cinemas_file = file;
1059 if (boost::filesystem::exists (_cinemas_file)) {
1060 /* Existing file; read it in */
1061 cxml::Document f ("Cinemas");
1062 f.read_file (_cinemas_file);
1070 Config::save_template (shared_ptr<const Film> film, string name) const
1072 film->write_template (template_path (name));
1076 Config::templates () const
1078 if (!boost::filesystem::exists (path ("templates"))) {
1079 return list<string> ();
1083 for (boost::filesystem::directory_iterator i (path("templates")); i != boost::filesystem::directory_iterator(); ++i) {
1084 n.push_back (i->path().filename().string());
1090 Config::existing_template (string name) const
1092 return boost::filesystem::exists (template_path (name));
1095 boost::filesystem::path
1096 Config::template_path (string name) const
1098 return path("templates") / tidy_for_filename (name);
1102 Config::rename_template (string old_name, string new_name) const
1104 boost::filesystem::rename (template_path (old_name), template_path (new_name));
1108 Config::delete_template (string name) const
1110 boost::filesystem::remove (template_path (name));
1113 /** @return Path to the config.xml containing the actual settings, following a link if required */
1114 boost::filesystem::path
1115 Config::config_file ()
1117 cxml::Document f ("Config");
1118 boost::filesystem::path main = path("config.xml", false);
1119 if (!boost::filesystem::exists (main)) {
1120 /* It doesn't exist, so there can't be any links; just return it */
1124 /* See if there's a link */
1126 optional<string> link = f.optional_string_child("Link");
1135 Config::reset_cover_sheet ()
1137 set_cover_sheet_to_default ();
1142 Config::link (boost::filesystem::path new_file) const
1144 xmlpp::Document doc;
1145 doc.create_root_node("Config")->add_child("Link")->add_child_text(new_file.string());
1147 doc.write_to_file_formatted(path("config.xml", true).string());
1148 } catch (xmlpp::exception& e) {
1149 string s = e.what ();
1151 throw FileError (s, path("config.xml"));
1156 Config::copy_and_link (boost::filesystem::path new_file) const
1159 boost::filesystem::copy_file (config_file(), new_file, boost::filesystem::copy_option::overwrite_if_exists);