2 Copyright (C) 2012-2017 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 <dcp/raw_convert.h>
34 #include <dcp/name_format.h>
35 #include <dcp/certificate_chain.h>
36 #include <libcxml/cxml.h>
38 #include <libxml++/libxml++.h>
39 #include <boost/filesystem.hpp>
40 #include <boost/algorithm/string.hpp>
41 #include <boost/foreach.hpp>
42 #include <boost/thread.hpp>
58 using boost::shared_ptr;
59 using boost::optional;
60 using boost::algorithm::trim;
61 using dcp::raw_convert;
63 Config* Config::_instance = 0;
64 boost::signals2::signal<void ()> Config::FailedToLoad;
66 /** Construct default configuration */
73 Config::set_defaults ()
75 _num_local_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
76 _server_port_base = 6192;
77 _use_any_servers = true;
79 _only_servers_encode = false;
80 _tms_protocol = PROTOCOL_SCP;
85 _cinema_sound_processor = CinemaSoundProcessor::from_id (N_("dolby_cp750"));
86 _allow_any_dcp_frame_rate = false;
87 _language = optional<string> ();
88 _default_still_length = 10;
89 _default_container = Ratio::from_id ("185");
90 _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
91 _default_dcp_audio_channels = 6;
92 _default_j2k_bandwidth = 100000000;
93 _default_audio_delay = 0;
94 _default_interop = true;
102 _check_for_updates = false;
103 _check_for_test_updates = false;
104 _maximum_j2k_bandwidth = 250000000;
105 _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR;
106 _analyse_ebur128 = true;
107 _automatic_audio_analysis = false;
108 #ifdef DCPOMATIC_WINDOWS
109 _win32_console = false;
111 _cinemas_file = path ("cinemas.xml");
112 _show_hints_before_make_dcp = true;
113 _confirm_kdm_email = true;
114 _kdm_container_name_format = dcp::NameFormat ("KDM %f %c");
115 _kdm_filename_format = dcp::NameFormat ("KDM %f %c %s");
116 _dcp_metadata_filename_format = dcp::NameFormat ("%t");
117 _dcp_asset_filename_format = dcp::NameFormat ("%t");
118 _jump_to_selected = true;
119 _preview_sound = false;
120 _preview_sound_output = optional<string> ();
122 _allowed_dcp_frame_rates.clear ();
123 _allowed_dcp_frame_rates.push_back (24);
124 _allowed_dcp_frame_rates.push_back (25);
125 _allowed_dcp_frame_rates.push_back (30);
126 _allowed_dcp_frame_rates.push_back (48);
127 _allowed_dcp_frame_rates.push_back (50);
128 _allowed_dcp_frame_rates.push_back (60);
130 set_kdm_email_to_default ();
134 Config::restore_defaults ()
136 Config::instance()->set_defaults ();
137 Config::instance()->changed ();
140 shared_ptr<dcp::CertificateChain>
141 Config::create_certificate_chain ()
143 return shared_ptr<dcp::CertificateChain> (
144 new dcp::CertificateChain (
148 ".dcpomatic.smpte-430-2.ROOT",
149 ".dcpomatic.smpte-430-2.INTERMEDIATE",
150 "CS.dcpomatic.smpte-430-2.LEAF"
159 cxml::Document f ("Config");
160 f.read_file (path ("config.xml"));
163 optional<int> version = f.optional_number_child<int> ("Version");
165 _num_local_encoding_threads = f.number_child<int> ("NumLocalEncodingThreads");
166 _default_directory = f.optional_string_child ("DefaultDirectory");
167 if (_default_directory && _default_directory->empty ()) {
168 /* We used to store an empty value for this to mean "none set" */
169 _default_directory = boost::optional<boost::filesystem::path> ();
172 boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
174 b = f.optional_number_child<int> ("ServerPortBase");
176 _server_port_base = b.get ();
178 boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
179 _use_any_servers = u.get_value_or (true);
181 list<cxml::NodePtr> servers = f.node_children ("Server");
182 for (list<cxml::NodePtr>::iterator i = servers.begin(); i != servers.end(); ++i) {
183 if ((*i)->node_children("HostName").size() == 1) {
184 _servers.push_back ((*i)->string_child ("HostName"));
186 _servers.push_back ((*i)->content ());
190 _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
191 _tms_protocol = static_cast<Protocol> (f.optional_number_child<int> ("TMSProtocol").get_value_or (static_cast<int> (PROTOCOL_SCP)));
192 _tms_ip = f.string_child ("TMSIP");
193 _tms_path = f.string_child ("TMSPath");
194 _tms_user = f.string_child ("TMSUser");
195 _tms_password = f.string_child ("TMSPassword");
197 c = f.optional_string_child ("SoundProcessor");
199 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
201 c = f.optional_string_child ("CinemaSoundProcessor");
203 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
206 _language = f.optional_string_child ("Language");
208 c = f.optional_string_child ("DefaultContainer");
210 _default_container = Ratio::from_id (c.get ());
213 c = f.optional_string_child ("DefaultDCPContentType");
215 _default_dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
218 _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
220 if (f.optional_string_child ("DCPMetadataIssuer")) {
221 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
222 } else if (f.optional_string_child ("DCPIssuer")) {
223 _dcp_issuer = f.string_child ("DCPIssuer");
226 _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
228 if (version && version.get() >= 2) {
229 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
231 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
234 _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
235 _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
236 _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
237 _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
238 _default_kdm_directory = f.optional_string_child("DefaultKDMDirectory");
240 /* Load any cinemas from config.xml */
243 _mail_server = f.string_child ("MailServer");
244 _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
245 _mail_user = f.optional_string_child("MailUser").get_value_or ("");
246 _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
247 _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
248 _kdm_from = f.string_child ("KDMFrom");
249 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("KDMCC")) {
250 if (!i->content().empty()) {
251 _kdm_cc.push_back (i->content ());
254 _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
255 _kdm_email = f.string_child ("KDMEmail");
257 _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
258 _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
260 _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
261 _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
263 _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
264 _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
265 _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
266 #ifdef DCPOMATIC_WINDOWS
267 _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
270 list<cxml::NodePtr> his = f.node_children ("History");
271 for (list<cxml::NodePtr>::const_iterator i = his.begin(); i != his.end(); ++i) {
272 _history.push_back ((*i)->content ());
275 cxml::NodePtr signer = f.optional_node_child ("Signer");
277 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
278 /* Read the signing certificates and private key in from the config file */
279 BOOST_FOREACH (cxml::NodePtr i, signer->node_children ("Certificate")) {
280 c->add (dcp::Certificate (i->content ()));
282 c->set_key (signer->string_child ("PrivateKey"));
285 /* Make a new set of signing certificates and key */
286 _signer_chain = create_certificate_chain ();
289 cxml::NodePtr decryption = f.optional_node_child ("Decryption");
291 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
292 BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) {
293 c->add (dcp::Certificate (i->content ()));
295 c->set_key (decryption->string_child ("PrivateKey"));
296 _decryption_chain = c;
298 _decryption_chain = create_certificate_chain ();
301 list<cxml::NodePtr> dkdm = f.node_children ("DKDM");
302 BOOST_FOREACH (cxml::NodePtr i, f.node_children ("DKDM")) {
303 _dkdms.push_back (dcp::EncryptedKDM (i->content ()));
306 _cinemas_file = f.optional_string_child("CinemasFile").get_value_or (path ("cinemas.xml").string ());
307 _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
308 _confirm_kdm_email = f.optional_bool_child("ConfirmKDMEmail").get_value_or (true);
309 _kdm_container_name_format = dcp::NameFormat (f.optional_string_child("KDMContainerNameFormat").get_value_or ("KDM %f %c"));
310 _kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
311 _dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t"));
312 _dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t"));
313 _jump_to_selected = f.optional_bool_child("JumpToSelected").get_value_or (true);
314 _preview_sound = f.optional_bool_child("PreviewSound").get_value_or (false);
315 _preview_sound_output = f.optional_string_child("PreviewSoundOutput");
317 /* Replace any cinemas from config.xml with those from the configured file */
318 if (boost::filesystem::exists (_cinemas_file)) {
319 cxml::Document f ("Cinemas");
320 f.read_file (_cinemas_file);
325 if (have_existing ("config.xml")) {
327 /* Make a copy of the configuration */
329 boost::filesystem::copy (path ("config.xml", false), path ("config.xml.backup", false));
330 boost::filesystem::copy (path ("cinemas.xml", false), path ("cinemas.xml.backup", false));
333 /* We have a config file but it didn't load */
337 /* Make a new set of signing certificates and key */
338 _signer_chain = create_certificate_chain ();
339 /* And similar for decryption of KDMs */
340 _decryption_chain = create_certificate_chain ();
345 /** @return Filename to write configuration to */
346 boost::filesystem::path
347 Config::path (string file, bool create_directories)
349 boost::filesystem::path p;
351 p /= g_get_home_dir ();
354 p /= "com.dcpomatic";
357 p /= g_get_user_config_dir ();
360 boost::system::error_code ec;
361 if (create_directories) {
362 boost::filesystem::create_directories (p, ec);
368 /** @return Singleton instance */
372 if (_instance == 0) {
373 _instance = new Config;
380 /** Write our configuration to disk */
382 Config::write () const
389 Config::write_config () const
392 xmlpp::Element* root = doc.create_root_node ("Config");
394 root->add_child("Version")->add_child_text ("2");
395 root->add_child("NumLocalEncodingThreads")->add_child_text (raw_convert<string> (_num_local_encoding_threads));
396 if (_default_directory) {
397 root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ());
399 root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
400 root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
402 for (vector<string>::const_iterator i = _servers.begin(); i != _servers.end(); ++i) {
403 root->add_child("Server")->add_child_text (*i);
406 root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
407 root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
408 root->add_child("TMSIP")->add_child_text (_tms_ip);
409 root->add_child("TMSPath")->add_child_text (_tms_path);
410 root->add_child("TMSUser")->add_child_text (_tms_user);
411 root->add_child("TMSPassword")->add_child_text (_tms_password);
412 if (_cinema_sound_processor) {
413 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
416 root->add_child("Language")->add_child_text (_language.get());
418 if (_default_container) {
419 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
421 if (_default_dcp_content_type) {
422 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
424 root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
425 root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
426 root->add_child("DCPCreator")->add_child_text (_dcp_creator);
428 _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
430 root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
431 root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
432 root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
433 root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
434 if (_default_kdm_directory) {
435 root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ());
437 root->add_child("MailServer")->add_child_text (_mail_server);
438 root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
439 root->add_child("MailUser")->add_child_text (_mail_user);
440 root->add_child("MailPassword")->add_child_text (_mail_password);
441 root->add_child("KDMSubject")->add_child_text (_kdm_subject);
442 root->add_child("KDMFrom")->add_child_text (_kdm_from);
443 BOOST_FOREACH (string i, _kdm_cc) {
444 root->add_child("KDMCC")->add_child_text (i);
446 root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
447 root->add_child("KDMEmail")->add_child_text (_kdm_email);
449 root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
450 root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
452 root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
453 root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
454 root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
455 root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
456 root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
457 #ifdef DCPOMATIC_WINDOWS
458 root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
461 xmlpp::Element* signer = root->add_child ("Signer");
462 DCPOMATIC_ASSERT (_signer_chain);
463 BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->root_to_leaf ()) {
464 signer->add_child("Certificate")->add_child_text (i.certificate (true));
466 signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
468 xmlpp::Element* decryption = root->add_child ("Decryption");
469 DCPOMATIC_ASSERT (_decryption_chain);
470 BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->root_to_leaf ()) {
471 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
473 decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
475 for (vector<boost::filesystem::path>::const_iterator i = _history.begin(); i != _history.end(); ++i) {
476 root->add_child("History")->add_child_text (i->string ());
479 BOOST_FOREACH (dcp::EncryptedKDM i, _dkdms) {
480 root->add_child("DKDM")->add_child_text (i.as_xml ());
483 root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
484 root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
485 root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0");
486 root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
487 root->add_child("KDMContainerNameFormat")->add_child_text (_kdm_container_name_format.specification ());
488 root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ());
489 root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ());
490 root->add_child("JumpToSelected")->add_child_text (_jump_to_selected ? "1" : "0");
491 root->add_child("PreviewSound")->add_child_text (_preview_sound ? "1" : "0");
492 if (_preview_sound_output) {
493 root->add_child("PreviewSoundOutput")->add_child_text (_preview_sound_output.get());
497 doc.write_to_file_formatted (path("config.xml").string ());
498 } catch (xmlpp::exception& e) {
499 string s = e.what ();
501 throw FileError (s, path("config.xml"));
506 Config::write_cinemas () const
509 xmlpp::Element* root = doc.create_root_node ("Cinemas");
510 root->add_child("Version")->add_child_text ("1");
512 for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
513 (*i)->as_xml (root->add_child ("Cinema"));
517 doc.write_to_file_formatted (_cinemas_file.string ());
518 } catch (xmlpp::exception& e) {
519 string s = e.what ();
521 throw FileError (s, _cinemas_file);
525 boost::filesystem::path
526 Config::default_directory_or (boost::filesystem::path a) const
528 return directory_or (_default_directory, a);
531 boost::filesystem::path
532 Config::default_kdm_directory_or (boost::filesystem::path a) const
534 return directory_or (_default_kdm_directory, a);
537 boost::filesystem::path
538 Config::directory_or (optional<boost::filesystem::path> dir, boost::filesystem::path a) const
544 boost::system::error_code ec;
545 bool const e = boost::filesystem::exists (*dir, ec);
561 Config::changed (Property what)
567 Config::set_kdm_email_to_default ()
569 _kdm_subject = _("KDM delivery: $CPL_NAME");
572 "Dear Projectionist\n\n"
573 "Please find attached KDMs for $CPL_NAME.\n\n"
574 "Cinema: $CINEMA_NAME\n"
575 "Screen(s): $SCREENS\n\n"
576 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
577 "Best regards,\nDCP-o-matic"
582 Config::reset_kdm_email ()
584 set_kdm_email_to_default ();
589 Config::add_to_history (boost::filesystem::path p)
591 /* Remove existing instances of this path in the history */
592 _history.erase (remove (_history.begin(), _history.end(), p), _history.end ());
594 _history.insert (_history.begin (), p);
595 if (_history.size() > HISTORY_SIZE) {
596 _history.pop_back ();
603 Config::have_existing (string file)
605 return boost::filesystem::exists (path (file, false));
609 Config::read_cinemas (cxml::Document const & f)
612 list<cxml::NodePtr> cin = f.node_children ("Cinema");
613 for (list<cxml::NodePtr>::iterator i = cin.begin(); i != cin.end(); ++i) {
614 /* Slightly grotty two-part construction of Cinema here so that we can use
617 shared_ptr<Cinema> cinema (new Cinema (*i));
618 cinema->read_screens (*i);
619 _cinemas.push_back (cinema);
624 Config::set_cinemas_file (boost::filesystem::path file)
626 _cinemas_file = file;
628 if (boost::filesystem::exists (_cinemas_file)) {
629 /* Existing file; read it in */
630 cxml::Document f ("Cinemas");
631 f.read_file (_cinemas_file);
639 Config::save_template (shared_ptr<const Film> film, string name) const
641 film->write_template (template_path (name));
645 Config::templates () const
647 if (!boost::filesystem::exists (path ("templates"))) {
648 return list<string> ();
652 for (boost::filesystem::directory_iterator i (path("templates")); i != boost::filesystem::directory_iterator(); ++i) {
653 n.push_back (i->path().filename().string());
659 Config::existing_template (string name) const
661 return boost::filesystem::exists (template_path (name));
664 boost::filesystem::path
665 Config::template_path (string name) const
667 return path("templates") / tidy_for_filename (name);
671 Config::rename_template (string old_name, string new_name) const
673 boost::filesystem::rename (template_path (old_name), template_path (new_name));
677 Config::delete_template (string name) const
679 boost::filesystem::remove (template_path (name));