2 Copyright (C) 2012-2016 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_filename_format = dcp::NameFormat ("KDM %f %c %s");
115 _dcp_metadata_filename_format = dcp::NameFormat ("%t");
116 _dcp_asset_filename_format = dcp::NameFormat ("%t");
118 _allowed_dcp_frame_rates.clear ();
119 _allowed_dcp_frame_rates.push_back (24);
120 _allowed_dcp_frame_rates.push_back (25);
121 _allowed_dcp_frame_rates.push_back (30);
122 _allowed_dcp_frame_rates.push_back (48);
123 _allowed_dcp_frame_rates.push_back (50);
124 _allowed_dcp_frame_rates.push_back (60);
126 set_kdm_email_to_default ();
130 Config::restore_defaults ()
132 Config::instance()->set_defaults ();
133 Config::instance()->changed ();
136 shared_ptr<dcp::CertificateChain>
137 Config::create_certificate_chain ()
139 return shared_ptr<dcp::CertificateChain> (
140 new dcp::CertificateChain (
144 ".dcpomatic.smpte-430-2.ROOT",
145 ".dcpomatic.smpte-430-2.INTERMEDIATE",
146 "CS.dcpomatic.smpte-430-2.LEAF"
155 cxml::Document f ("Config");
156 f.read_file (path ("config.xml"));
159 optional<int> version = f.optional_number_child<int> ("Version");
161 _num_local_encoding_threads = f.number_child<int> ("NumLocalEncodingThreads");
162 _default_directory = f.optional_string_child ("DefaultDirectory");
163 if (_default_directory && _default_directory->empty ()) {
164 /* We used to store an empty value for this to mean "none set" */
165 _default_directory = boost::optional<boost::filesystem::path> ();
168 boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
170 b = f.optional_number_child<int> ("ServerPortBase");
172 _server_port_base = b.get ();
174 boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
175 _use_any_servers = u.get_value_or (true);
177 list<cxml::NodePtr> servers = f.node_children ("Server");
178 for (list<cxml::NodePtr>::iterator i = servers.begin(); i != servers.end(); ++i) {
179 if ((*i)->node_children("HostName").size() == 1) {
180 _servers.push_back ((*i)->string_child ("HostName"));
182 _servers.push_back ((*i)->content ());
186 _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
187 _tms_protocol = static_cast<Protocol> (f.optional_number_child<int> ("TMSProtocol").get_value_or (static_cast<int> (PROTOCOL_SCP)));
188 _tms_ip = f.string_child ("TMSIP");
189 _tms_path = f.string_child ("TMSPath");
190 _tms_user = f.string_child ("TMSUser");
191 _tms_password = f.string_child ("TMSPassword");
193 c = f.optional_string_child ("SoundProcessor");
195 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
197 c = f.optional_string_child ("CinemaSoundProcessor");
199 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
202 _language = f.optional_string_child ("Language");
204 c = f.optional_string_child ("DefaultContainer");
206 _default_container = Ratio::from_id (c.get ());
209 c = f.optional_string_child ("DefaultDCPContentType");
211 _default_dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
214 _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
216 if (f.optional_string_child ("DCPMetadataIssuer")) {
217 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
218 } else if (f.optional_string_child ("DCPIssuer")) {
219 _dcp_issuer = f.string_child ("DCPIssuer");
222 _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
224 if (version && version.get() >= 2) {
225 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
227 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
230 _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
231 _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
232 _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
233 _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
234 _default_kdm_directory = f.optional_string_child("DefaultKDMDirectory");
236 /* Load any cinemas from config.xml */
239 _mail_server = f.string_child ("MailServer");
240 _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
241 _mail_user = f.optional_string_child("MailUser").get_value_or ("");
242 _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
243 _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
244 _kdm_from = f.string_child ("KDMFrom");
245 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("KDMCC")) {
246 if (!i->content().empty()) {
247 _kdm_cc.push_back (i->content ());
250 _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
251 _kdm_email = f.string_child ("KDMEmail");
253 _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
254 _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
256 _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
257 _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
259 _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
260 _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
261 _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
262 #ifdef DCPOMATIC_WINDOWS
263 _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
266 list<cxml::NodePtr> his = f.node_children ("History");
267 for (list<cxml::NodePtr>::const_iterator i = his.begin(); i != his.end(); ++i) {
268 _history.push_back ((*i)->content ());
271 cxml::NodePtr signer = f.optional_node_child ("Signer");
273 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
274 /* Read the signing certificates and private key in from the config file */
275 BOOST_FOREACH (cxml::NodePtr i, signer->node_children ("Certificate")) {
276 c->add (dcp::Certificate (i->content ()));
278 c->set_key (signer->string_child ("PrivateKey"));
281 /* Make a new set of signing certificates and key */
282 _signer_chain = create_certificate_chain ();
285 cxml::NodePtr decryption = f.optional_node_child ("Decryption");
287 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
288 BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) {
289 c->add (dcp::Certificate (i->content ()));
291 c->set_key (decryption->string_child ("PrivateKey"));
292 _decryption_chain = c;
294 _decryption_chain = create_certificate_chain ();
297 list<cxml::NodePtr> dkdm = f.node_children ("DKDM");
298 BOOST_FOREACH (cxml::NodePtr i, f.node_children ("DKDM")) {
299 _dkdms.push_back (dcp::EncryptedKDM (i->content ()));
302 _cinemas_file = f.optional_string_child("CinemasFile").get_value_or (path ("cinemas.xml").string ());
303 _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
304 _confirm_kdm_email = f.optional_bool_child("ConfirmKDMEmail").get_value_or (true);
305 _kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
306 _dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t"));
307 _dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t"));
309 /* Replace any cinemas from config.xml with those from the configured file */
310 if (boost::filesystem::exists (_cinemas_file)) {
311 cxml::Document f ("Cinemas");
312 f.read_file (_cinemas_file);
317 if (have_existing ("config.xml")) {
318 /* We have a config file but it didn't load */
322 /* Make a new set of signing certificates and key */
323 _signer_chain = create_certificate_chain ();
324 /* And similar for decryption of KDMs */
325 _decryption_chain = create_certificate_chain ();
330 /** @return Filename to write configuration to */
331 boost::filesystem::path
332 Config::path (string file, bool create_directories)
334 boost::filesystem::path p;
336 p /= g_get_home_dir ();
339 p /= "com.dcpomatic";
342 p /= g_get_user_config_dir ();
345 boost::system::error_code ec;
346 if (create_directories) {
347 boost::filesystem::create_directories (p, ec);
353 /** @return Singleton instance */
357 if (_instance == 0) {
358 _instance = new Config;
365 /** Write our configuration to disk */
367 Config::write () const
370 write_cinemas_xml ();
374 Config::write_config_xml () const
377 xmlpp::Element* root = doc.create_root_node ("Config");
379 root->add_child("Version")->add_child_text ("2");
380 root->add_child("NumLocalEncodingThreads")->add_child_text (raw_convert<string> (_num_local_encoding_threads));
381 if (_default_directory) {
382 root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ());
384 root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
385 root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
387 for (vector<string>::const_iterator i = _servers.begin(); i != _servers.end(); ++i) {
388 root->add_child("Server")->add_child_text (*i);
391 root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
392 root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
393 root->add_child("TMSIP")->add_child_text (_tms_ip);
394 root->add_child("TMSPath")->add_child_text (_tms_path);
395 root->add_child("TMSUser")->add_child_text (_tms_user);
396 root->add_child("TMSPassword")->add_child_text (_tms_password);
397 if (_cinema_sound_processor) {
398 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
401 root->add_child("Language")->add_child_text (_language.get());
403 if (_default_container) {
404 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
406 if (_default_dcp_content_type) {
407 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
409 root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
410 root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
411 root->add_child("DCPCreator")->add_child_text (_dcp_creator);
413 _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
415 root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
416 root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
417 root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
418 root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
419 if (_default_kdm_directory) {
420 root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ());
422 root->add_child("MailServer")->add_child_text (_mail_server);
423 root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
424 root->add_child("MailUser")->add_child_text (_mail_user);
425 root->add_child("MailPassword")->add_child_text (_mail_password);
426 root->add_child("KDMSubject")->add_child_text (_kdm_subject);
427 root->add_child("KDMFrom")->add_child_text (_kdm_from);
428 BOOST_FOREACH (string i, _kdm_cc) {
429 root->add_child("KDMCC")->add_child_text (i);
431 root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
432 root->add_child("KDMEmail")->add_child_text (_kdm_email);
434 root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
435 root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
437 root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
438 root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
439 root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
440 root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
441 root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
442 #ifdef DCPOMATIC_WINDOWS
443 root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
446 xmlpp::Element* signer = root->add_child ("Signer");
447 DCPOMATIC_ASSERT (_signer_chain);
448 BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->root_to_leaf ()) {
449 signer->add_child("Certificate")->add_child_text (i.certificate (true));
451 signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
453 xmlpp::Element* decryption = root->add_child ("Decryption");
454 DCPOMATIC_ASSERT (_decryption_chain);
455 BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->root_to_leaf ()) {
456 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
458 decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
460 for (vector<boost::filesystem::path>::const_iterator i = _history.begin(); i != _history.end(); ++i) {
461 root->add_child("History")->add_child_text (i->string ());
464 BOOST_FOREACH (dcp::EncryptedKDM i, _dkdms) {
465 root->add_child("DKDM")->add_child_text (i.as_xml ());
468 root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
469 root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
470 root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0");
471 root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
472 root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ());
473 root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ());
476 doc.write_to_file_formatted (path("config.xml").string ());
477 } catch (xmlpp::exception& e) {
478 string s = e.what ();
480 throw FileError (s, path("config.xml"));
485 Config::write_cinemas_xml () const
488 xmlpp::Element* root = doc.create_root_node ("Cinemas");
489 root->add_child("Version")->add_child_text ("1");
491 for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
492 (*i)->as_xml (root->add_child ("Cinema"));
496 doc.write_to_file_formatted (_cinemas_file.string ());
497 } catch (xmlpp::exception& e) {
498 string s = e.what ();
500 throw FileError (s, _cinemas_file);
504 boost::filesystem::path
505 Config::default_directory_or (boost::filesystem::path a) const
507 return directory_or (_default_directory, a);
510 boost::filesystem::path
511 Config::default_kdm_directory_or (boost::filesystem::path a) const
513 return directory_or (_default_kdm_directory, a);
516 boost::filesystem::path
517 Config::directory_or (optional<boost::filesystem::path> dir, boost::filesystem::path a) const
523 boost::system::error_code ec;
524 bool const e = boost::filesystem::exists (*dir, ec);
540 Config::changed (Property what)
546 Config::set_kdm_email_to_default ()
548 _kdm_subject = _("KDM delivery: $CPL_NAME");
551 "Dear Projectionist\n\n"
552 "Please find attached KDMs for $CPL_NAME.\n\n"
553 "Cinema: $CINEMA_NAME\n"
554 "Screen(s): $SCREENS\n\n"
555 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
556 "Best regards,\nDCP-o-matic"
561 Config::reset_kdm_email ()
563 set_kdm_email_to_default ();
568 Config::add_to_history (boost::filesystem::path p)
570 /* Remove existing instances of this path in the history */
571 _history.erase (remove (_history.begin(), _history.end(), p), _history.end ());
573 _history.insert (_history.begin (), p);
574 if (_history.size() > HISTORY_SIZE) {
575 _history.pop_back ();
582 Config::have_existing (string file)
584 return boost::filesystem::exists (path (file, false));
588 Config::read_cinemas (cxml::Document const & f)
591 list<cxml::NodePtr> cin = f.node_children ("Cinema");
592 for (list<cxml::NodePtr>::iterator i = cin.begin(); i != cin.end(); ++i) {
593 /* Slightly grotty two-part construction of Cinema here so that we can use
596 shared_ptr<Cinema> cinema (new Cinema (*i));
597 cinema->read_screens (*i);
598 _cinemas.push_back (cinema);
603 Config::set_cinemas_file (boost::filesystem::path file)
605 _cinemas_file = file;
607 if (boost::filesystem::exists (_cinemas_file)) {
608 /* Existing file; read it in */
609 cxml::Document f ("Cinemas");
610 f.read_file (_cinemas_file);
618 Config::save_template (shared_ptr<const Film> film, string name) const
620 film->write_template (template_path (name));
624 Config::templates () const
626 if (!boost::filesystem::exists (path ("templates"))) {
627 return list<string> ();
631 for (boost::filesystem::directory_iterator i (path("templates")); i != boost::filesystem::directory_iterator(); ++i) {
632 n.push_back (i->path().filename().string());
638 Config::existing_template (string name) const
640 return boost::filesystem::exists (template_path (name));
643 boost::filesystem::path
644 Config::template_path (string name) const
646 return path("templates") / tidy_for_filename (name);
650 Config::rename_template (string old_name, string new_name) const
652 boost::filesystem::rename (template_path (old_name), template_path (new_name));
656 Config::delete_template (string name) const
658 boost::filesystem::remove (template_path (name));