2 Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
26 #include "dcp_content_type.h"
27 #include "colour_conversion.h"
32 #include "dkdm_wrapper.h"
33 #include "compose.hpp"
35 #include "dkdm_recipient.h"
36 #include <dcp/raw_convert.h>
37 #include <dcp/name_format.h>
38 #include <dcp/certificate_chain.h>
39 #include <libcxml/cxml.h>
41 #include <libxml++/libxml++.h>
42 #include <boost/filesystem.hpp>
43 #include <boost/algorithm/string.hpp>
44 #include <boost/foreach.hpp>
45 #include <boost/thread.hpp>
62 using boost::shared_ptr;
63 using boost::optional;
64 using boost::dynamic_pointer_cast;
65 using boost::algorithm::trim;
66 using dcp::raw_convert;
68 Config* Config::_instance = 0;
69 int const Config::_current_version = 3;
70 boost::signals2::signal<void ()> Config::FailedToLoad;
71 boost::signals2::signal<void (string)> Config::Warning;
72 boost::signals2::signal<bool (Config::BadReason)> Config::Bad;
74 /** Construct default configuration */
76 /* DKDMs are not considered a thing to reset on set_defaults() */
77 : _dkdms (new DKDMGroup ("root"))
83 Config::set_defaults ()
85 _master_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
86 _server_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
87 _server_port_base = 6192;
88 _use_any_servers = true;
90 _only_servers_encode = false;
91 _tms_protocol = FILE_TRANSFER_PROTOCOL_SCP;
96 _allow_any_dcp_frame_rate = false;
97 _allow_any_container = false;
98 _show_experimental_audio_processors = false;
99 _language = optional<string> ();
100 _default_still_length = 10;
101 _default_container = Ratio::from_id ("185");
102 _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
103 _default_dcp_audio_channels = 6;
104 _default_j2k_bandwidth = 150000000;
105 _default_audio_delay = 0;
106 _default_interop = true;
107 _upload_after_make_dcp = false;
110 _mail_protocol = EMAIL_PROTOCOL_AUTO;
116 _notification_from = "";
117 _notification_to = "";
118 _notification_cc.clear ();
119 _notification_bcc = "";
120 _check_for_updates = false;
121 _check_for_test_updates = false;
122 _maximum_j2k_bandwidth = 250000000;
123 _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR | LogEntry::TYPE_DISK;
124 _analyse_ebur128 = true;
125 _automatic_audio_analysis = false;
126 #ifdef DCPOMATIC_WINDOWS
127 _win32_console = false;
129 _cinemas_file = path ("cinemas.xml");
130 _dkdm_recipients_file = path ("dkdm_recipients.xml");
131 _show_hints_before_make_dcp = true;
132 _confirm_kdm_email = true;
133 _kdm_container_name_format = dcp::NameFormat ("KDM %f %c");
134 _kdm_filename_format = dcp::NameFormat ("KDM %f %c %s");
135 _dkdm_filename_format = dcp::NameFormat ("DKDM %f %c %s");
136 _dcp_metadata_filename_format = dcp::NameFormat ("%t");
137 _dcp_asset_filename_format = dcp::NameFormat ("%t");
138 _jump_to_selected = true;
139 for (int i = 0; i < NAG_COUNT; ++i) {
143 _sound_output = optional<string> ();
144 _last_kdm_write_type = KDM_WRITE_FLAT;
145 _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
147 /* I think the scaling factor here should be the ratio of the longest frame
148 encode time to the shortest; if the thread count is T, longest time is L
149 and the shortest time S we could encode L/S frames per thread whilst waiting
150 for the L frame to encode so we might have to store LT/S frames.
152 However we don't want to use too much memory, so keep it a bit lower than we'd
153 perhaps like. A J2K frame is typically about 1Mb so 3 here will mean we could
154 use about 240Mb with 72 encoding threads.
156 _frames_in_memory_multiplier = 3;
157 _decode_reduction = optional<int>();
158 _default_notify = false;
159 for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
160 _notification[i] = false;
162 _barco_username = optional<string>();
163 _barco_password = optional<string>();
164 _christie_username = optional<string>();
165 _christie_password = optional<string>();
166 _gdc_username = optional<string>();
167 _gdc_password = optional<string>();
168 _player_mode = PLAYER_MODE_WINDOW;
170 _video_view_type = VIDEO_VIEW_SIMPLE;
171 _respect_kdm_validity_periods = true;
172 _player_activity_log_file = boost::none;
173 _player_debug_log_file = boost::none;
174 _player_content_directory = boost::none;
175 _player_playlist_directory = boost::none;
176 _player_kdm_directory = boost::none;
177 _audio_mapping = boost::none;
179 _allowed_dcp_frame_rates.clear ();
180 _allowed_dcp_frame_rates.push_back (24);
181 _allowed_dcp_frame_rates.push_back (25);
182 _allowed_dcp_frame_rates.push_back (30);
183 _allowed_dcp_frame_rates.push_back (48);
184 _allowed_dcp_frame_rates.push_back (50);
185 _allowed_dcp_frame_rates.push_back (60);
187 set_kdm_email_to_default ();
188 set_notification_email_to_default ();
189 set_cover_sheet_to_default ();
193 Config::restore_defaults ()
195 Config::instance()->set_defaults ();
196 Config::instance()->changed ();
199 shared_ptr<dcp::CertificateChain>
200 Config::create_certificate_chain ()
202 return shared_ptr<dcp::CertificateChain> (
203 new dcp::CertificateChain (
207 ".dcpomatic.smpte-430-2.ROOT",
208 ".dcpomatic.smpte-430-2.INTERMEDIATE",
209 "CS.dcpomatic.smpte-430-2.LEAF"
217 /* Make a copy of the configuration */
220 while (n < 100 && boost::filesystem::exists(path(String::compose("config.xml.%1", n)))) {
224 boost::filesystem::copy_file(path("config.xml", false), path(String::compose("config.xml.%1", n), false));
225 boost::filesystem::copy_file(path("cinemas.xml", false), path(String::compose("cinemas.xml.%1", n), false));
226 boost::filesystem::copy_file(path("dkdm_recipients.xml", false), path(String::compose("dkdm_recipients.xml.%1", n), false));
234 cxml::Document f ("Config");
235 f.read_file (config_file ());
237 optional<int> version = f.optional_number_child<int> ("Version");
238 if (version && *version < _current_version) {
239 /* Back up the old config before we re-write it in a back-incompatible way */
243 if (f.optional_number_child<int>("NumLocalEncodingThreads")) {
244 _master_encoding_threads = _server_encoding_threads = f.optional_number_child<int>("NumLocalEncodingThreads").get();
246 _master_encoding_threads = f.number_child<int>("MasterEncodingThreads");
247 _server_encoding_threads = f.number_child<int>("ServerEncodingThreads");
250 _default_directory = f.optional_string_child ("DefaultDirectory");
251 if (_default_directory && _default_directory->empty ()) {
252 /* We used to store an empty value for this to mean "none set" */
253 _default_directory = boost::optional<boost::filesystem::path> ();
256 boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
258 b = f.optional_number_child<int> ("ServerPortBase");
260 _server_port_base = b.get ();
262 boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
263 _use_any_servers = u.get_value_or (true);
265 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Server")) {
266 if (i->node_children("HostName").size() == 1) {
267 _servers.push_back (i->string_child ("HostName"));
269 _servers.push_back (i->content ());
273 _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
274 _tms_protocol = static_cast<FileTransferProtocol>(f.optional_number_child<int>("TMSProtocol").get_value_or(static_cast<int>(FILE_TRANSFER_PROTOCOL_SCP)));
275 _tms_ip = f.string_child ("TMSIP");
276 _tms_path = f.string_child ("TMSPath");
277 _tms_user = f.string_child ("TMSUser");
278 _tms_password = f.string_child ("TMSPassword");
280 _language = f.optional_string_child ("Language");
282 optional<string> c = f.optional_string_child ("DefaultContainer");
284 _default_container = Ratio::from_id (c.get ());
287 if (_default_container && !_default_container->used_for_container()) {
288 Warning (_("Your default container is not valid and has been changed to Flat (1.85:1)"));
289 _default_container = Ratio::from_id ("185");
292 _default_dcp_content_type = DCPContentType::from_isdcf_name(f.optional_string_child("DefaultDCPContentType").get_value_or("FTR"));
293 _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
295 if (f.optional_string_child ("DCPMetadataIssuer")) {
296 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
297 } else if (f.optional_string_child ("DCPIssuer")) {
298 _dcp_issuer = f.string_child ("DCPIssuer");
301 optional<bool> up = f.optional_bool_child("UploadAfterMakeDCP");
303 up = f.optional_bool_child("DefaultUploadAfterMakeDCP");
305 _upload_after_make_dcp = up.get_value_or (false);
306 _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
307 _dcp_company_name = f.optional_string_child("DCPCompanyName").get_value_or("");
308 _dcp_product_name = f.optional_string_child("DCPProductName").get_value_or("");
309 _dcp_product_version = f.optional_string_child("DCPProductVersion").get_value_or("");
310 _dcp_j2k_comment = f.optional_string_child("DCPJ2KComment").get_value_or("");
312 if (version && version.get() >= 2) {
313 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
315 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
318 _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
319 _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
320 _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
321 _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
322 _default_kdm_directory = f.optional_string_child("DefaultKDMDirectory");
324 /* Read any cinemas that are still lying around in the config file
325 * from an old version.
329 _mail_server = f.string_child ("MailServer");
330 _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
333 /* Make sure this matches the code in write_config */
334 string const protocol = f.optional_string_child("MailProtocol").get_value_or("Auto");
335 if (protocol == "Auto") {
336 _mail_protocol = EMAIL_PROTOCOL_AUTO;
337 } else if (protocol == "Plain") {
338 _mail_protocol = EMAIL_PROTOCOL_PLAIN;
339 } else if (protocol == "STARTTLS") {
340 _mail_protocol = EMAIL_PROTOCOL_STARTTLS;
341 } else if (protocol == "SSL") {
342 _mail_protocol = EMAIL_PROTOCOL_SSL;
346 _mail_user = f.optional_string_child("MailUser").get_value_or ("");
347 _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
349 _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
350 _kdm_from = f.string_child ("KDMFrom");
351 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("KDMCC")) {
352 if (!i->content().empty()) {
353 _kdm_cc.push_back (i->content ());
356 _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
357 _kdm_email = f.string_child ("KDMEmail");
359 _notification_subject = f.optional_string_child("NotificationSubject").get_value_or(_("DCP-o-matic notification"));
360 _notification_from = f.optional_string_child("NotificationFrom").get_value_or("");
361 _notification_to = f.optional_string_child("NotificationTo").get_value_or("");
362 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("NotificationCC")) {
363 if (!i->content().empty()) {
364 _notification_cc.push_back (i->content ());
367 _notification_bcc = f.optional_string_child("NotificationBCC").get_value_or("");
368 if (f.optional_string_child("NotificationEmail")) {
369 _notification_email = f.string_child("NotificationEmail");
372 _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
373 _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
375 _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
376 _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
377 _allow_any_container = f.optional_bool_child ("AllowAnyContainer").get_value_or (false);
378 _show_experimental_audio_processors = f.optional_bool_child ("ShowExperimentalAudioProcessors").get_value_or (false);
380 _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
381 _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
382 _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
383 #ifdef DCPOMATIC_WINDOWS
384 _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
387 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("History")) {
388 _history.push_back (i->content ());
391 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("PlayerHistory")) {
392 _player_history.push_back (i->content ());
395 cxml::NodePtr signer = f.optional_node_child ("Signer");
397 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
398 /* Read the signing certificates and private key in from the config file */
399 BOOST_FOREACH (cxml::NodePtr i, signer->node_children ("Certificate")) {
400 c->add (dcp::Certificate (i->content ()));
402 c->set_key (signer->string_child ("PrivateKey"));
405 /* Make a new set of signing certificates and key */
406 _signer_chain = create_certificate_chain ();
409 cxml::NodePtr decryption = f.optional_node_child ("Decryption");
411 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
412 BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) {
413 c->add (dcp::Certificate (i->content ()));
415 c->set_key (decryption->string_child ("PrivateKey"));
416 _decryption_chain = c;
418 _decryption_chain = create_certificate_chain ();
421 /* These must be done before we call Bad as that might set one
424 BOOST_FOREACH (cxml::NodePtr i, f.node_children("Nagged")) {
425 int const id = i->number_attribute<int>("Id");
426 if (id >= 0 && id < NAG_COUNT) {
427 _nagged[id] = raw_convert<int>(i->content());
431 optional<BadReason> bad;
433 BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->unordered()) {
434 if (i.has_utf8_strings()) {
435 bad = BAD_SIGNER_UTF8_STRINGS;
439 if (!_signer_chain->chain_valid() || !_signer_chain->private_key_valid()) {
440 bad = BAD_SIGNER_INCONSISTENT;
443 if (!_decryption_chain->chain_valid() || !_decryption_chain->private_key_valid()) {
444 bad = BAD_DECRYPTION_INCONSISTENT;
448 optional<bool> const remake = Bad(*bad);
449 if (remake && *remake) {
451 case BAD_SIGNER_UTF8_STRINGS:
452 case BAD_SIGNER_INCONSISTENT:
453 _signer_chain = create_certificate_chain ();
455 case BAD_DECRYPTION_INCONSISTENT:
456 _decryption_chain = create_certificate_chain ();
462 if (f.optional_node_child("DKDMGroup")) {
463 /* New-style: all DKDMs in a group */
464 _dkdms = dynamic_pointer_cast<DKDMGroup> (DKDMBase::read (f.node_child("DKDMGroup")));
466 /* Old-style: one or more DKDM nodes */
467 _dkdms.reset (new DKDMGroup ("root"));
468 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("DKDM")) {
469 _dkdms->add (DKDMBase::read (i));
472 _cinemas_file = f.optional_string_child("CinemasFile").get_value_or (path ("cinemas.xml").string ());
473 _dkdm_recipients_file = f.optional_string_child("DKDMRecipientsFile").get_value_or (path("dkdm_recipients.xml").string());
474 _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
475 _confirm_kdm_email = f.optional_bool_child("ConfirmKDMEmail").get_value_or (true);
476 _kdm_container_name_format = dcp::NameFormat (f.optional_string_child("KDMContainerNameFormat").get_value_or ("KDM %f %c"));
477 _kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
478 _dkdm_filename_format = dcp::NameFormat (f.optional_string_child("DKDMFilenameFormat").get_value_or("DKDM %f %c %s"));
479 _dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t"));
480 _dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t"));
481 _jump_to_selected = f.optional_bool_child("JumpToSelected").get_value_or (true);
482 /* The variable was renamed but not the XML tag */
483 _sound = f.optional_bool_child("PreviewSound").get_value_or (true);
484 _sound_output = f.optional_string_child("PreviewSoundOutput");
485 if (f.optional_string_child("CoverSheet")) {
486 _cover_sheet = f.optional_string_child("CoverSheet").get();
488 _last_player_load_directory = f.optional_string_child("LastPlayerLoadDirectory");
489 if (f.optional_string_child("LastKDMWriteType")) {
490 if (f.optional_string_child("LastKDMWriteType").get() == "flat") {
491 _last_kdm_write_type = KDM_WRITE_FLAT;
492 } else if (f.optional_string_child("LastKDMWriteType").get() == "folder") {
493 _last_kdm_write_type = KDM_WRITE_FOLDER;
494 } else if (f.optional_string_child("LastKDMWriteType").get() == "zip") {
495 _last_kdm_write_type = KDM_WRITE_ZIP;
498 if (f.optional_string_child("LastDKDMWriteType")) {
499 if (f.optional_string_child("LastDKDMWriteType").get() == "internal") {
500 _last_dkdm_write_type = DKDM_WRITE_INTERNAL;
501 } else if (f.optional_string_child("LastDKDMWriteType").get() == "file") {
502 _last_dkdm_write_type = DKDM_WRITE_FILE;
505 _frames_in_memory_multiplier = f.optional_number_child<int>("FramesInMemoryMultiplier").get_value_or(3);
506 _decode_reduction = f.optional_number_child<int>("DecodeReduction");
507 _default_notify = f.optional_bool_child("DefaultNotify").get_value_or(false);
509 BOOST_FOREACH (cxml::NodePtr i, f.node_children("Notification")) {
510 int const id = i->number_attribute<int>("Id");
511 if (id >= 0 && id < NOTIFICATION_COUNT) {
512 _notification[id] = raw_convert<int>(i->content());
516 _barco_username = f.optional_string_child("BarcoUsername");
517 _barco_password = f.optional_string_child("BarcoPassword");
518 _christie_username = f.optional_string_child("ChristieUsername");
519 _christie_password = f.optional_string_child("ChristiePassword");
520 _gdc_username = f.optional_string_child("GDCUsername");
521 _gdc_password = f.optional_string_child("GDCPassword");
523 optional<string> pm = f.optional_string_child("PlayerMode");
524 if (pm && *pm == "window") {
525 _player_mode = PLAYER_MODE_WINDOW;
526 } else if (pm && *pm == "full") {
527 _player_mode = PLAYER_MODE_FULL;
528 } else if (pm && *pm == "dual") {
529 _player_mode = PLAYER_MODE_DUAL;
532 _image_display = f.optional_number_child<int>("ImageDisplay").get_value_or(0);
533 optional<string> vc = f.optional_string_child("VideoViewType");
534 if (vc && *vc == "opengl") {
535 _video_view_type = VIDEO_VIEW_OPENGL;
536 } else if (vc && *vc == "simple") {
537 _video_view_type = VIDEO_VIEW_SIMPLE;
539 _respect_kdm_validity_periods = f.optional_bool_child("RespectKDMValidityPeriods").get_value_or(true);
540 /* PlayerLogFile is old name */
541 _player_activity_log_file = f.optional_string_child("PlayerLogFile");
542 if (!_player_activity_log_file) {
543 _player_activity_log_file = f.optional_string_child("PlayerActivityLogFile");
545 _player_debug_log_file = f.optional_string_child("PlayerDebugLogFile");
546 _player_content_directory = f.optional_string_child("PlayerContentDirectory");
547 _player_playlist_directory = f.optional_string_child("PlayerPlaylistDirectory");
548 _player_kdm_directory = f.optional_string_child("PlayerKDMDirectory");
550 if (f.optional_node_child("AudioMapping")) {
551 _audio_mapping = AudioMapping (f.node_child("AudioMapping"), Film::current_state_version);
554 if (boost::filesystem::exists (_cinemas_file)) {
555 cxml::Document f ("Cinemas");
556 f.read_file (_cinemas_file);
560 if (boost::filesystem::exists (_dkdm_recipients_file)) {
561 cxml::Document f ("DKDMRecipients");
562 f.read_file (_dkdm_recipients_file);
563 read_dkdm_recipients (f);
567 if (have_existing ("config.xml")) {
569 /* We have a config file but it didn't load */
573 /* Make a new set of signing certificates and key */
574 _signer_chain = create_certificate_chain ();
575 /* And similar for decryption of KDMs */
576 _decryption_chain = create_certificate_chain ();
580 /** @return Singleton instance */
584 if (_instance == 0) {
585 _instance = new Config;
592 /** Write our configuration to disk */
594 Config::write () const
598 write_dkdm_recipients ();
602 Config::write_config () const
605 xmlpp::Element* root = doc.create_root_node ("Config");
607 /* [XML] Version The version number of the configuration file format. */
608 root->add_child("Version")->add_child_text (raw_convert<string>(_current_version));
609 /* [XML] MasterEncodingThreads Number of encoding threads to use when running as master. */
610 root->add_child("MasterEncodingThreads")->add_child_text (raw_convert<string> (_master_encoding_threads));
611 /* [XML] ServerEncodingThreads Number of encoding threads to use when running as server. */
612 root->add_child("ServerEncodingThreads")->add_child_text (raw_convert<string> (_server_encoding_threads));
613 if (_default_directory) {
614 /* [XML:opt] DefaultDirectory Default directory when creating a new film in the GUI. */
615 root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ());
617 /* [XML] ServerPortBase Port number to use for frame encoding requests. <code>ServerPortBase</code> + 1 and
618 <code>ServerPortBase</code> + 2 are used for querying servers. <code>ServerPortBase</code> + 3 is used
619 by the batch converter to listen for job requests.
621 root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
622 /* [XML] UseAnyServers 1 to broadcast to look for encoding servers to use, 0 to use only those configured. */
623 root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
625 BOOST_FOREACH (string i, _servers) {
626 /* [XML:opt] Server IP address or hostname of an encoding server to use; you can use as many of these tags
629 root->add_child("Server")->add_child_text (i);
632 /* [XML] OnlyServersEncode 1 to set the master to do decoding of source content no JPEG2000 encoding; all encoding
633 is done by the encoding servers. 0 to set the master to do some encoding as well as coordinating the job.
635 root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
636 /* [XML] TMSProtocol Protocol to use to copy files to a TMS; 0 to use SCP, 1 for FTP. */
637 root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
638 /* [XML] TMSIP IP address of TMS. */
639 root->add_child("TMSIP")->add_child_text (_tms_ip);
640 /* [XML] TMSPath Path on the TMS to copy files to. */
641 root->add_child("TMSPath")->add_child_text (_tms_path);
642 /* [XML] TMSUser Username to log into the TMS with. */
643 root->add_child("TMSUser")->add_child_text (_tms_user);
644 /* [XML] TMSPassword Password to log into the TMS with. */
645 root->add_child("TMSPassword")->add_child_text (_tms_password);
647 /* [XML:opt] Language Language to use in the GUI e.g. <code>fr_FR</code>. */
648 root->add_child("Language")->add_child_text (_language.get());
650 if (_default_container) {
651 /* [XML:opt] DefaultContainer ID of default container
652 to use when creating new films (<code>185</code>,<code>239</code> or
655 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
657 if (_default_dcp_content_type) {
658 /* [XML:opt] DefaultDCPContentType Default content type ot use when creating new films (<code>FTR</code>, <code>SHR</code>,
659 <code>TLR</code>, <code>TST</code>, <code>XSN</code>, <code>RTG</code>, <code>TSR</code>, <code>POL</code>,
660 <code>PSA</code> or <code>ADV</code>). */
661 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
663 /* [XML] DefaultDCPAudioChannels Default number of audio channels to use when creating new films. */
664 root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
665 /* [XML] DCPIssuer Issuer text to write into CPL files. */
666 root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
667 /* [XML] DCPIssuer Creator text to write into CPL files. */
668 root->add_child("DCPCreator")->add_child_text (_dcp_creator);
669 /* [XML] Company name to write into MXF files. */
670 root->add_child("DCPCompanyName")->add_child_text (_dcp_company_name);
671 /* [XML] Product name to write into MXF files. */
672 root->add_child("DCPProductName")->add_child_text (_dcp_product_name);
673 /* [XML] Product version to write into MXF files. */
674 root->add_child("DCPProductVersion")->add_child_text (_dcp_product_version);
675 /* [XML] Comment to write into JPEG2000 data. */
676 root->add_child("DCPJ2KComment")->add_child_text (_dcp_j2k_comment);
677 /* [XML] UploadAfterMakeDCP 1 to upload to a TMS after making a DCP, 0 for no upload. */
678 root->add_child("UploadAfterMakeDCP")->add_child_text (_upload_after_make_dcp ? "1" : "0");
680 /* [XML] ISDCFMetadata Default ISDCF metadata to use for new films; child tags are <code><ContentVersion></code>,
681 <code><AudioLanguage></code>, <code><SubtitleLanguage></code>, <code><Territory></code>,
682 <code><Rating></code>, <code><Studio></code>, <code><Facility></code>, <code><TempVersion></code>,
683 <code><PreRelease></code>, <code><RedBand></code>, <code><Chain></code>, <code><TwoDVersionOFThreeD></code>,
684 <code><MasteredLuminance></code>.
686 _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
688 /* [XML] DefaultStillLength Default length (in seconds) for still images in new films. */
689 root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
690 /* [XML] DefaultJ2KBandwidth Default bitrate (in bits per second) for JPEG2000 data in new films. */
691 root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
692 /* [XML] DefaultAudioDelay Default delay to apply to audio (positive moves audio later) in milliseconds. */
693 root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
694 /* [XML] DefaultInterop 1 to default new films to Interop, 0 for SMPTE. */
695 root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
696 if (_default_kdm_directory) {
697 /* [XML:opt] DefaultKDMDirectory Default directory to write KDMs to. */
698 root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ());
700 /* [XML] MailServer Hostname of SMTP server to use. */
701 root->add_child("MailServer")->add_child_text (_mail_server);
702 /* [XML] MailPort Port number to use on SMTP server. */
703 root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
704 /* [XML] MailProtocol Protocol to use on SMTP server (Auto, Plain, STARTTLS or SSL) */
705 switch (_mail_protocol) {
706 case EMAIL_PROTOCOL_AUTO:
707 root->add_child("MailProtocol")->add_child_text("Auto");
709 case EMAIL_PROTOCOL_PLAIN:
710 root->add_child("MailProtocol")->add_child_text("Plain");
712 case EMAIL_PROTOCOL_STARTTLS:
713 root->add_child("MailProtocol")->add_child_text("STARTTLS");
715 case EMAIL_PROTOCOL_SSL:
716 root->add_child("MailProtocol")->add_child_text("SSL");
719 /* [XML] MailUser Username to use on SMTP server. */
720 root->add_child("MailUser")->add_child_text (_mail_user);
721 /* [XML] MailPassword Password to use on SMTP server. */
722 root->add_child("MailPassword")->add_child_text (_mail_password);
724 /* [XML] KDMSubject Subject to use for KDM emails. */
725 root->add_child("KDMSubject")->add_child_text (_kdm_subject);
726 /* [XML] KDMFrom From address to use for KDM emails. */
727 root->add_child("KDMFrom")->add_child_text (_kdm_from);
728 BOOST_FOREACH (string i, _kdm_cc) {
729 /* [XML] KDMCC CC address to use for KDM emails; you can use as many of these tags as you like. */
730 root->add_child("KDMCC")->add_child_text (i);
732 /* [XML] KDMBCC BCC address to use for KDM emails. */
733 root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
734 /* [XML] KDMEmail Text of KDM email. */
735 root->add_child("KDMEmail")->add_child_text (_kdm_email);
737 /* [XML] NotificationSubject Subject to use for notification emails. */
738 root->add_child("NotificationSubject")->add_child_text (_notification_subject);
739 /* [XML] NotificationFrom From address to use for notification emails. */
740 root->add_child("NotificationFrom")->add_child_text (_notification_from);
741 /* [XML] NotificationFrom To address to use for notification emails. */
742 root->add_child("NotificationTo")->add_child_text (_notification_to);
743 BOOST_FOREACH (string i, _notification_cc) {
744 /* [XML] NotificationCC CC address to use for notification emails; you can use as many of these tags as you like. */
745 root->add_child("NotificationCC")->add_child_text (i);
747 /* [XML] NotificationBCC BCC address to use for notification emails. */
748 root->add_child("NotificationBCC")->add_child_text (_notification_bcc);
749 /* [XML] NotificationEmail Text of notification email. */
750 root->add_child("NotificationEmail")->add_child_text (_notification_email);
752 /* [XML] CheckForUpdates 1 to check dcpomatic.com for new versions, 0 to check only on request. */
753 root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
754 /* [XML] CheckForUpdates 1 to check dcpomatic.com for new text versions, 0 to check only on request. */
755 root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
757 /* [XML] MaximumJ2KBandwidth Maximum J2K bandwidth (in bits per second) that can be specified in the GUI. */
758 root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
759 /* [XML] AllowAnyDCPFrameRate 1 to allow users to specify any frame rate when creating DCPs, 0 to limit the GUI to standard rates. */
760 root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
761 /* [XML] AllowAnyContainer 1 to allow users to user any container ratio for their DCP, 0 to limit the GUI to DCI Flat/Scope */
762 root->add_child("AllowAnyContainer")->add_child_text (_allow_any_container ? "1" : "0");
763 /* [XML] ShowExperimentalAudioProcessors 1 to offer users the (experimental) audio upmixer processors, 0 to hide them */
764 root->add_child("ShowExperimentalAudioProcessors")->add_child_text (_show_experimental_audio_processors ? "1" : "0");
765 /* [XML] LogTypes Types of logging to write; a bitfield where 1 is general notes, 2 warnings, 4 errors, 8 debug information related
766 to 3D, 16 debug information related to encoding, 32 debug information for timing purposes, 64 debug information related
767 to sending email, 128 debug information related to the video view, 256 information about disk writing, 512 debug information
768 related to the player, 1024 debug information related to audio analyses.
770 root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
771 /* [XML] AnalyseEBUR128 1 to do EBUR128 analyses when analysing audio, otherwise 0. */
772 root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
773 /* [XML] AutomaticAudioAnalysis 1 to run audio analysis automatically when audio content is added to the film, otherwise 0. */
774 root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
775 #ifdef DCPOMATIC_WINDOWS
776 /* [XML] Win32Console 1 to open a console when running on Windows, otherwise 0. */
777 root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
780 /* [XML] Signer Certificate chain and private key to use when signing DCPs and KDMs. Should contain <code><Certificate></code>
781 tags in order and a <code><PrivateKey></code> tag all containing PEM-encoded certificates or private keys as appropriate.
783 xmlpp::Element* signer = root->add_child ("Signer");
784 DCPOMATIC_ASSERT (_signer_chain);
785 BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->unordered()) {
786 signer->add_child("Certificate")->add_child_text (i.certificate (true));
788 signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
790 /* [XML] Decryption Certificate chain and private key to use when decrypting KDMs */
791 xmlpp::Element* decryption = root->add_child ("Decryption");
792 DCPOMATIC_ASSERT (_decryption_chain);
793 BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->unordered()) {
794 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
796 decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
798 /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the GUI; there can be more than one
801 BOOST_FOREACH (boost::filesystem::path i, _history) {
802 root->add_child("History")->add_child_text (i.string ());
805 /* [XML] History Filename of DCP to present in the <guilabel>File</guilabel> menu of the player; there can be more than one
808 BOOST_FOREACH (boost::filesystem::path i, _player_history) {
809 root->add_child("PlayerHistory")->add_child_text (i.string ());
812 /* [XML] DKDMGroup A group of DKDMs, each with a <code>Name</code> attribute, containing other <code><DKDMGroup></code>
813 or <code><DKDM></code> tags.
815 /* [XML] DKDM A DKDM as XML */
816 _dkdms->as_xml (root);
818 /* [XML] CinemasFile Filename of cinemas list file. */
819 root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
820 /* [XML] DKDMRecipientsFile Filename of DKDM recipients list file. */
821 root->add_child("DKDMRecipientsFile")->add_child_text (_dkdm_recipients_file.string());
822 /* [XML] ShowHintsBeforeMakeDCP 1 to show hints in the GUI before making a DCP, otherwise 0. */
823 root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
824 /* [XML] ConfirmKDMEmail 1 to confirm before sending KDM emails in the GUI, otherwise 0. */
825 root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0");
826 /* [XML] KDMFilenameFormat Format for KDM filenames. */
827 root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
828 /* [XML] KDMFilenameFormat Format for DKDM filenames. */
829 root->add_child("DKDMFilenameFormat")->add_child_text(_dkdm_filename_format.specification());
830 /* [XML] KDMContainerNameFormat Format for KDM containers (directories or ZIP files). */
831 root->add_child("KDMContainerNameFormat")->add_child_text (_kdm_container_name_format.specification ());
832 /* [XML] DCPMetadataFilenameFormat Format for DCP metadata filenames. */
833 root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ());
834 /* [XML] DCPAssetFilenameFormat Format for DCP asset filenames. */
835 root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ());
836 /* [XML] JumpToSelected 1 to make the GUI jump to the start of content when it is selected, otherwise 0. */
837 root->add_child("JumpToSelected")->add_child_text (_jump_to_selected ? "1" : "0");
838 /* [XML] Nagged 1 if a particular nag screen has been shown and should not be shown again, otherwise 0. */
839 for (int i = 0; i < NAG_COUNT; ++i) {
840 xmlpp::Element* e = root->add_child ("Nagged");
841 e->set_attribute ("Id", raw_convert<string>(i));
842 e->add_child_text (_nagged[i] ? "1" : "0");
844 /* [XML] PreviewSound 1 to use sound in the GUI preview and player, otherwise 0. */
845 root->add_child("PreviewSound")->add_child_text (_sound ? "1" : "0");
847 /* [XML:opt] PreviewSoundOutput Name of the audio output to use. */
848 root->add_child("PreviewSoundOutput")->add_child_text (_sound_output.get());
850 /* [XML] CoverSheet Text of the cover sheet to write when making DCPs. */
851 root->add_child("CoverSheet")->add_child_text (_cover_sheet);
852 if (_last_player_load_directory) {
853 root->add_child("LastPlayerLoadDirectory")->add_child_text(_last_player_load_directory->string());
855 /* [XML] LastKDMWriteType Last type of KDM-write: <code>flat</code> for a flat file, <code>folder</code> for a folder or <code>zip</code> for a ZIP file. */
856 if (_last_kdm_write_type) {
857 switch (_last_kdm_write_type.get()) {
859 root->add_child("LastKDMWriteType")->add_child_text("flat");
861 case KDM_WRITE_FOLDER:
862 root->add_child("LastKDMWriteType")->add_child_text("folder");
865 root->add_child("LastKDMWriteType")->add_child_text("zip");
869 /* [XML] LastDKDMWriteType Last type of DKDM-write: <code>file</code> for a file, <code>internal</code> to add to DCP-o-matic's list. */
870 if (_last_dkdm_write_type) {
871 switch (_last_dkdm_write_type.get()) {
872 case DKDM_WRITE_INTERNAL:
873 root->add_child("LastDKDMWriteType")->add_child_text("internal");
875 case DKDM_WRITE_FILE:
876 root->add_child("LastDKDMWriteType")->add_child_text("file");
880 /* [XML] FramesInMemoryMultiplier value to multiply the encoding threads count by to get the maximum number of
881 frames to be held in memory at once.
883 root->add_child("FramesInMemoryMultiplier")->add_child_text(raw_convert<string>(_frames_in_memory_multiplier));
885 /* [XML] DecodeReduction power of 2 to reduce DCP images by before decoding in the player. */
886 if (_decode_reduction) {
887 root->add_child("DecodeReduction")->add_child_text(raw_convert<string>(_decode_reduction.get()));
890 /* [XML] DefaultNotify 1 to default jobs to notify when complete, otherwise 0. */
891 root->add_child("DefaultNotify")->add_child_text(_default_notify ? "1" : "0");
893 /* [XML] Notification 1 if a notification type is enabled, otherwise 0. */
894 for (int i = 0; i < NOTIFICATION_COUNT; ++i) {
895 xmlpp::Element* e = root->add_child ("Notification");
896 e->set_attribute ("Id", raw_convert<string>(i));
897 e->add_child_text (_notification[i] ? "1" : "0");
900 if (_barco_username) {
901 /* [XML] BarcoUsername Username for logging into Barco's servers when downloading server certificates. */
902 root->add_child("BarcoUsername")->add_child_text(*_barco_username);
904 if (_barco_password) {
905 /* [XML] BarcoPassword Password for logging into Barco's servers when downloading server certificates. */
906 root->add_child("BarcoPassword")->add_child_text(*_barco_password);
909 if (_christie_username) {
910 /* [XML] ChristieUsername Username for logging into Christie's servers when downloading server certificates. */
911 root->add_child("ChristieUsername")->add_child_text(*_christie_username);
913 if (_christie_password) {
914 /* [XML] ChristiePassword Password for logging into Christie's servers when downloading server certificates. */
915 root->add_child("ChristiePassword")->add_child_text(*_christie_password);
919 /* [XML] GDCUsername Username for logging into GDC's servers when downloading server certificates. */
920 root->add_child("GDCUsername")->add_child_text(*_gdc_username);
923 /* [XML] GDCPassword Password for logging into GDC's servers when downloading server certificates. */
924 root->add_child("GDCPassword")->add_child_text(*_gdc_password);
927 /* [XML] PlayerMode <code>window</code> for a single window, <code>full</code> for full-screen and <code>dual</code> for full screen playback
928 with controls on another monitor.
930 switch (_player_mode) {
931 case PLAYER_MODE_WINDOW:
932 root->add_child("PlayerMode")->add_child_text("window");
934 case PLAYER_MODE_FULL:
935 root->add_child("PlayerMode")->add_child_text("full");
937 case PLAYER_MODE_DUAL:
938 root->add_child("PlayerMode")->add_child_text("dual");
942 /* [XML] ImageDisplay Screen number to put image on in dual-screen player mode. */
943 root->add_child("ImageDisplay")->add_child_text(raw_convert<string>(_image_display));
944 switch (_video_view_type) {
945 case VIDEO_VIEW_SIMPLE:
946 root->add_child("VideoViewType")->add_child_text("simple");
948 case VIDEO_VIEW_OPENGL:
949 root->add_child("VideoViewType")->add_child_text("opengl");
952 /* [XML] RespectKDMValidityPeriods 1 to refuse to use KDMs that are out of date, 0 to ignore KDM dates. */
953 root->add_child("RespectKDMValidityPeriods")->add_child_text(_respect_kdm_validity_periods ? "1" : "0");
954 if (_player_activity_log_file) {
955 /* [XML] PlayerLogFile Filename to use for player activity logs (e.g starting, stopping, playlist loads) */
956 root->add_child("PlayerActivityLogFile")->add_child_text(_player_activity_log_file->string());
958 if (_player_debug_log_file) {
959 /* [XML] PlayerLogFile Filename to use for player debug logs */
960 root->add_child("PlayerDebugLogFile")->add_child_text(_player_debug_log_file->string());
962 if (_player_content_directory) {
963 /* [XML] PlayerContentDirectory Directory to use for player content in the dual-screen mode. */
964 root->add_child("PlayerContentDirectory")->add_child_text(_player_content_directory->string());
966 if (_player_playlist_directory) {
967 /* [XML] PlayerPlaylistDirectory Directory to use for player playlists in the dual-screen mode. */
968 root->add_child("PlayerPlaylistDirectory")->add_child_text(_player_playlist_directory->string());
970 if (_player_kdm_directory) {
971 /* [XML] PlayerKDMDirectory Directory to use for player KDMs in the dual-screen mode. */
972 root->add_child("PlayerKDMDirectory")->add_child_text(_player_kdm_directory->string());
974 if (_audio_mapping) {
975 _audio_mapping->as_xml (root->add_child("AudioMapping"));
979 string const s = doc.write_to_string_formatted ();
980 boost::filesystem::path tmp (string(config_file().string()).append(".tmp"));
981 FILE* f = fopen_boost (tmp, "w");
983 throw FileError (_("Could not open file for writing"), tmp);
985 checked_fwrite (s.c_str(), s.length(), f, tmp);
987 boost::filesystem::remove (config_file());
988 boost::filesystem::rename (tmp, config_file());
989 } catch (xmlpp::exception& e) {
990 string s = e.what ();
992 throw FileError (s, config_file());
999 write_file (string root_node, string node, string version, list<shared_ptr<T> > things, boost::filesystem::path file)
1001 xmlpp::Document doc;
1002 xmlpp::Element* root = doc.create_root_node (root_node);
1003 root->add_child("Version")->add_child_text(version);
1005 BOOST_FOREACH (shared_ptr<T> i, things) {
1006 i->as_xml (root->add_child(node));
1010 doc.write_to_file_formatted (file.string() + ".tmp");
1011 boost::filesystem::remove (file);
1012 boost::filesystem::rename (file.string() + ".tmp", file);
1013 } catch (xmlpp::exception& e) {
1014 string s = e.what ();
1016 throw FileError (s, file);
1022 Config::write_cinemas () const
1024 write_file ("Cinemas", "Cinema", "1", _cinemas, _cinemas_file);
1029 Config::write_dkdm_recipients () const
1031 write_file ("DKDMRecipients", "DKDMRecipient", "1", _dkdm_recipients, _dkdm_recipients_file);
1035 boost::filesystem::path
1036 Config::default_directory_or (boost::filesystem::path a) const
1038 return directory_or (_default_directory, a);
1041 boost::filesystem::path
1042 Config::default_kdm_directory_or (boost::filesystem::path a) const
1044 return directory_or (_default_kdm_directory, a);
1047 boost::filesystem::path
1048 Config::directory_or (optional<boost::filesystem::path> dir, boost::filesystem::path a) const
1054 boost::system::error_code ec;
1055 bool const e = boost::filesystem::exists (*dir, ec);
1071 Config::changed (Property what)
1077 Config::set_kdm_email_to_default ()
1079 _kdm_subject = _("KDM delivery: $CPL_NAME");
1082 "Dear Projectionist\n\n"
1083 "Please find attached KDMs for $CPL_NAME.\n\n"
1084 "Cinema: $CINEMA_NAME\n"
1085 "Screen(s): $SCREENS\n\n"
1086 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
1087 "Best regards,\nDCP-o-matic"
1092 Config::set_notification_email_to_default ()
1094 _notification_subject = _("DCP-o-matic notification");
1096 _notification_email = _(
1097 "$JOB_NAME: $JOB_STATUS"
1102 Config::reset_kdm_email ()
1104 set_kdm_email_to_default ();
1109 Config::reset_notification_email ()
1111 set_notification_email_to_default ();
1116 Config::set_cover_sheet_to_default ()
1121 "Format: $CONTAINER\n"
1123 "Audio Language: $AUDIO_LANGUAGE\n"
1124 "Subtitle Language: $SUBTITLE_LANGUAGE\n"
1131 Config::add_to_history (boost::filesystem::path p)
1133 add_to_history_internal (_history, p);
1136 /** Remove non-existant items from the history */
1138 Config::clean_history ()
1140 clean_history_internal (_history);
1144 Config::add_to_player_history (boost::filesystem::path p)
1146 add_to_history_internal (_player_history, p);
1149 /** Remove non-existant items from the player history */
1151 Config::clean_player_history ()
1153 clean_history_internal (_player_history);
1157 Config::add_to_history_internal (vector<boost::filesystem::path>& h, boost::filesystem::path p)
1159 /* Remove existing instances of this path in the history */
1160 h.erase (remove (h.begin(), h.end(), p), h.end ());
1162 h.insert (h.begin (), p);
1163 if (h.size() > HISTORY_SIZE) {
1171 Config::clean_history_internal (vector<boost::filesystem::path>& h)
1173 vector<boost::filesystem::path> old = h;
1175 BOOST_FOREACH (boost::filesystem::path i, old) {
1177 if (boost::filesystem::is_directory(i)) {
1181 /* We couldn't find out if it's a directory for some reason; just ignore it */
1187 Config::have_existing (string file)
1189 return boost::filesystem::exists (path (file, false));
1193 Config::read_cinemas (cxml::Document const & f)
1196 list<cxml::NodePtr> cin = f.node_children ("Cinema");
1197 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Cinema")) {
1198 /* Slightly grotty two-part construction of Cinema here so that we can use
1201 shared_ptr<Cinema> cinema (new Cinema (i));
1202 cinema->read_screens (i);
1203 _cinemas.push_back (cinema);
1208 Config::set_cinemas_file (boost::filesystem::path file)
1210 if (file == _cinemas_file) {
1214 _cinemas_file = file;
1216 if (boost::filesystem::exists (_cinemas_file)) {
1217 /* Existing file; read it in */
1218 cxml::Document f ("Cinemas");
1219 f.read_file (_cinemas_file);
1228 Config::read_dkdm_recipients (cxml::Document const & f)
1230 _dkdm_recipients.clear ();
1231 list<cxml::NodePtr> cin = f.node_children ("DKDMRecipient");
1232 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("DKDMRecipient")) {
1233 _dkdm_recipients.push_back (shared_ptr<DKDMRecipient>(new DKDMRecipient(i)));
1238 Config::set_dkdm_recipients_file (boost::filesystem::path file)
1240 if (file == _dkdm_recipients_file) {
1244 _dkdm_recipients_file = file;
1246 if (boost::filesystem::exists (_dkdm_recipients_file)) {
1247 /* Existing file; read it in */
1248 cxml::Document f ("DKDMRecipients");
1249 f.read_file (_dkdm_recipients_file);
1250 read_dkdm_recipients (f);
1258 Config::save_template (shared_ptr<const Film> film, string name) const
1260 film->write_template (template_path (name));
1264 Config::templates () const
1266 if (!boost::filesystem::exists (path ("templates"))) {
1267 return list<string> ();
1271 for (boost::filesystem::directory_iterator i (path("templates")); i != boost::filesystem::directory_iterator(); ++i) {
1272 n.push_back (i->path().filename().string());
1278 Config::existing_template (string name) const
1280 return boost::filesystem::exists (template_path (name));
1283 boost::filesystem::path
1284 Config::template_path (string name) const
1286 return path("templates") / tidy_for_filename (name);
1290 Config::rename_template (string old_name, string new_name) const
1292 boost::filesystem::rename (template_path (old_name), template_path (new_name));
1296 Config::delete_template (string name) const
1298 boost::filesystem::remove (template_path (name));
1301 /** @return Path to the config.xml containing the actual settings, following a link if required */
1302 boost::filesystem::path
1303 Config::config_file ()
1305 cxml::Document f ("Config");
1306 boost::filesystem::path main = path("config.xml", false);
1307 if (!boost::filesystem::exists (main)) {
1308 /* It doesn't exist, so there can't be any links; just return it */
1312 /* See if there's a link */
1315 optional<string> link = f.optional_string_child("Link");
1319 } catch (xmlpp::exception& e) {
1320 /* There as a problem reading the main configuration file,
1321 so there can't be a link.
1329 Config::reset_cover_sheet ()
1331 set_cover_sheet_to_default ();
1336 Config::link (boost::filesystem::path new_file) const
1338 xmlpp::Document doc;
1339 doc.create_root_node("Config")->add_child("Link")->add_child_text(new_file.string());
1341 doc.write_to_file_formatted(path("config.xml", true).string());
1342 } catch (xmlpp::exception& e) {
1343 string s = e.what ();
1345 throw FileError (s, path("config.xml"));
1350 Config::copy_and_link (boost::filesystem::path new_file) const
1353 boost::filesystem::copy_file (config_file(), new_file, boost::filesystem::copy_option::overwrite_if_exists);
1358 Config::have_write_permission () const
1360 FILE* f = fopen_boost (config_file(), "r+");
1369 /** @param output_channels Number of output channels in use.
1370 * @return Audio mapping for this output channel count (may be a default).
1373 Config::audio_mapping (int output_channels)
1375 if (!_audio_mapping || _audio_mapping->output_channels() != output_channels) {
1376 /* Set up a default */
1377 _audio_mapping = AudioMapping (MAX_DCP_AUDIO_CHANNELS, output_channels);
1378 if (output_channels == 2) {
1379 /* Special case for stereo output.
1380 Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
1381 Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
1383 _audio_mapping->set (dcp::LEFT, 0, 1 / sqrt(2)); // L -> Lt
1384 _audio_mapping->set (dcp::RIGHT, 1, 1 / sqrt(2)); // R -> Rt
1385 _audio_mapping->set (dcp::CENTRE, 0, 1 / 2.0); // C -> Lt
1386 _audio_mapping->set (dcp::CENTRE, 1, 1 / 2.0); // C -> Rt
1387 _audio_mapping->set (dcp::LFE, 0, 1 / sqrt(10)); // Lfe -> Lt
1388 _audio_mapping->set (dcp::LFE, 1, 1 / sqrt(10)); // Lfe -> Rt
1389 _audio_mapping->set (dcp::LS, 0, 1 / sqrt(2)); // Ls -> Lt
1390 _audio_mapping->set (dcp::RS, 1, 1 / sqrt(2)); // Rs -> Rt
1393 for (int i = 0; i < min (MAX_DCP_AUDIO_CHANNELS, output_channels); ++i) {
1394 _audio_mapping->set (i, i, 1);
1399 return *_audio_mapping;
1403 Config::set_audio_mapping (AudioMapping m)
1406 changed (AUDIO_MAPPING);
1410 Config::set_audio_mapping_to_default ()
1412 DCPOMATIC_ASSERT (_audio_mapping);
1413 int const ch = _audio_mapping->output_channels ();
1414 _audio_mapping = boost::none;
1415 _audio_mapping = audio_mapping (ch);
1416 changed (AUDIO_MAPPING);