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"
32 #include "raw_convert.h"
33 #include <dcp/colour_matrix.h>
34 #include <dcp/certificate_chain.h>
35 #include <libcxml/cxml.h>
37 #include <libxml++/libxml++.h>
38 #include <boost/filesystem.hpp>
39 #include <boost/algorithm/string.hpp>
40 #include <boost/foreach.hpp>
41 #include <boost/thread.hpp>
57 using boost::shared_ptr;
58 using boost::optional;
59 using boost::algorithm::trim;
61 Config* Config::_instance = 0;
62 boost::signals2::signal<void ()> Config::FailedToLoad;
64 /** Construct default configuration */
71 Config::set_defaults ()
73 _num_local_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
74 _server_port_base = 6192;
75 _use_any_servers = true;
77 _only_servers_encode = false;
78 _tms_protocol = PROTOCOL_SCP;
83 _cinema_sound_processor = CinemaSoundProcessor::from_id (N_("dolby_cp750"));
84 _allow_any_dcp_frame_rate = false;
85 _language = optional<string> ();
86 _default_still_length = 10;
87 _default_container = Ratio::from_id ("185");
88 _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
89 _default_dcp_audio_channels = 6;
90 _default_j2k_bandwidth = 100000000;
91 _default_audio_delay = 0;
92 _default_interop = false;
100 _check_for_updates = false;
101 _check_for_test_updates = false;
102 _maximum_j2k_bandwidth = 250000000;
103 _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR;
104 _analyse_ebur128 = true;
105 _automatic_audio_analysis = false;
106 #ifdef DCPOMATIC_WINDOWS
107 _win32_console = false;
109 _cinemas_file = path ("cinemas.xml");
110 _show_hints_before_make_dcp = true;
112 _allowed_dcp_frame_rates.clear ();
113 _allowed_dcp_frame_rates.push_back (24);
114 _allowed_dcp_frame_rates.push_back (25);
115 _allowed_dcp_frame_rates.push_back (30);
116 _allowed_dcp_frame_rates.push_back (48);
117 _allowed_dcp_frame_rates.push_back (50);
118 _allowed_dcp_frame_rates.push_back (60);
120 set_kdm_email_to_default ();
124 Config::restore_defaults ()
126 Config::instance()->set_defaults ();
127 Config::instance()->changed ();
130 shared_ptr<dcp::CertificateChain>
131 Config::create_certificate_chain ()
133 return shared_ptr<dcp::CertificateChain> (
134 new dcp::CertificateChain (
138 ".dcpomatic.smpte-430-2.ROOT",
139 ".dcpomatic.smpte-430-2.INTERMEDIATE",
140 "CS.dcpomatic.smpte-430-2.LEAF"
149 cxml::Document f ("Config");
150 f.read_file (path ("config.xml"));
153 optional<int> version = f.optional_number_child<int> ("Version");
155 _num_local_encoding_threads = f.number_child<int> ("NumLocalEncodingThreads");
156 _default_directory = f.string_child ("DefaultDirectory");
158 boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
160 b = f.optional_number_child<int> ("ServerPortBase");
162 _server_port_base = b.get ();
164 boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
165 _use_any_servers = u.get_value_or (true);
167 list<cxml::NodePtr> servers = f.node_children ("Server");
168 for (list<cxml::NodePtr>::iterator i = servers.begin(); i != servers.end(); ++i) {
169 if ((*i)->node_children("HostName").size() == 1) {
170 _servers.push_back ((*i)->string_child ("HostName"));
172 _servers.push_back ((*i)->content ());
176 _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
177 _tms_protocol = static_cast<Protocol> (f.optional_number_child<int> ("TMSProtocol").get_value_or (static_cast<int> (PROTOCOL_SCP)));
178 _tms_ip = f.string_child ("TMSIP");
179 _tms_path = f.string_child ("TMSPath");
180 _tms_user = f.string_child ("TMSUser");
181 _tms_password = f.string_child ("TMSPassword");
183 c = f.optional_string_child ("SoundProcessor");
185 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
187 c = f.optional_string_child ("CinemaSoundProcessor");
189 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
192 _language = f.optional_string_child ("Language");
194 c = f.optional_string_child ("DefaultContainer");
196 _default_container = Ratio::from_id (c.get ());
199 c = f.optional_string_child ("DefaultDCPContentType");
201 _default_dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
204 _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
206 if (f.optional_string_child ("DCPMetadataIssuer")) {
207 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
208 } else if (f.optional_string_child ("DCPIssuer")) {
209 _dcp_issuer = f.string_child ("DCPIssuer");
212 _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
214 if (version && version.get() >= 2) {
215 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
217 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
220 _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
221 _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
222 _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
223 _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
225 /* Load any cinemas from config.xml */
228 _mail_server = f.string_child ("MailServer");
229 _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
230 _mail_user = f.optional_string_child("MailUser").get_value_or ("");
231 _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
232 _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
233 _kdm_from = f.string_child ("KDMFrom");
234 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("KDMCC")) {
235 if (!i->content().empty()) {
236 _kdm_cc.push_back (i->content ());
239 _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
240 _kdm_email = f.string_child ("KDMEmail");
242 _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
243 _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
245 _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
246 _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
248 _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
249 _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
250 _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
251 #ifdef DCPOMATIC_WINDOWS
252 _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
255 list<cxml::NodePtr> his = f.node_children ("History");
256 for (list<cxml::NodePtr>::const_iterator i = his.begin(); i != his.end(); ++i) {
257 _history.push_back ((*i)->content ());
260 cxml::NodePtr signer = f.optional_node_child ("Signer");
262 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
263 /* Read the signing certificates and private key in from the config file */
264 BOOST_FOREACH (cxml::NodePtr i, signer->node_children ("Certificate")) {
265 c->add (dcp::Certificate (i->content ()));
267 c->set_key (signer->string_child ("PrivateKey"));
270 /* Make a new set of signing certificates and key */
271 _signer_chain = create_certificate_chain ();
274 cxml::NodePtr decryption = f.optional_node_child ("Decryption");
276 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
277 BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) {
278 c->add (dcp::Certificate (i->content ()));
280 c->set_key (decryption->string_child ("PrivateKey"));
281 _decryption_chain = c;
283 _decryption_chain = create_certificate_chain ();
286 list<cxml::NodePtr> dkdm = f.node_children ("DKDM");
287 BOOST_FOREACH (cxml::NodePtr i, f.node_children ("DKDM")) {
288 _dkdms.push_back (dcp::EncryptedKDM (i->content ()));
291 _cinemas_file = f.optional_string_child("CinemasFile").get_value_or (path ("cinemas.xml").string ());
292 _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
294 /* Replace any cinemas from config.xml with those from the configured file */
295 if (boost::filesystem::exists (_cinemas_file)) {
296 cxml::Document f ("Cinemas");
297 f.read_file (_cinemas_file);
302 if (have_existing ("config.xml")) {
303 /* We have a config file but it didn't load */
307 /* Make a new set of signing certificates and key */
308 _signer_chain = create_certificate_chain ();
309 /* And similar for decryption of KDMs */
310 _decryption_chain = create_certificate_chain ();
315 /** @return Filename to write configuration to */
316 boost::filesystem::path
317 Config::path (string file, bool create_directories)
319 boost::filesystem::path p;
321 p /= g_get_home_dir ();
324 p /= "com.dcpomatic";
327 p /= g_get_user_config_dir ();
330 boost::system::error_code ec;
331 if (create_directories) {
332 boost::filesystem::create_directories (p, ec);
338 /** @return Singleton instance */
342 if (_instance == 0) {
343 _instance = new Config;
350 /** Write our configuration to disk */
352 Config::write () const
355 write_cinemas_xml ();
359 Config::write_config_xml () const
362 xmlpp::Element* root = doc.create_root_node ("Config");
364 root->add_child("Version")->add_child_text ("2");
365 root->add_child("NumLocalEncodingThreads")->add_child_text (raw_convert<string> (_num_local_encoding_threads));
366 root->add_child("DefaultDirectory")->add_child_text (_default_directory.string ());
367 root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
368 root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
370 for (vector<string>::const_iterator i = _servers.begin(); i != _servers.end(); ++i) {
371 root->add_child("Server")->add_child_text (*i);
374 root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
375 root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (_tms_protocol));
376 root->add_child("TMSIP")->add_child_text (_tms_ip);
377 root->add_child("TMSPath")->add_child_text (_tms_path);
378 root->add_child("TMSUser")->add_child_text (_tms_user);
379 root->add_child("TMSPassword")->add_child_text (_tms_password);
380 if (_cinema_sound_processor) {
381 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
384 root->add_child("Language")->add_child_text (_language.get());
386 if (_default_container) {
387 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
389 if (_default_dcp_content_type) {
390 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
392 root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
393 root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
394 root->add_child("DCPCreator")->add_child_text (_dcp_creator);
396 _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
398 root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
399 root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
400 root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
401 root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
402 root->add_child("MailServer")->add_child_text (_mail_server);
403 root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
404 root->add_child("MailUser")->add_child_text (_mail_user);
405 root->add_child("MailPassword")->add_child_text (_mail_password);
406 root->add_child("KDMSubject")->add_child_text (_kdm_subject);
407 root->add_child("KDMFrom")->add_child_text (_kdm_from);
408 BOOST_FOREACH (string i, _kdm_cc) {
409 root->add_child("KDMCC")->add_child_text (i);
411 root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
412 root->add_child("KDMEmail")->add_child_text (_kdm_email);
414 root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
415 root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
417 root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
418 root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
419 root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
420 root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
421 root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
422 #ifdef DCPOMATIC_WINDOWS
423 root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
426 xmlpp::Element* signer = root->add_child ("Signer");
427 DCPOMATIC_ASSERT (_signer_chain);
428 BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->root_to_leaf ()) {
429 signer->add_child("Certificate")->add_child_text (i.certificate (true));
431 signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
433 xmlpp::Element* decryption = root->add_child ("Decryption");
434 DCPOMATIC_ASSERT (_decryption_chain);
435 BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->root_to_leaf ()) {
436 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
438 decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
440 for (vector<boost::filesystem::path>::const_iterator i = _history.begin(); i != _history.end(); ++i) {
441 root->add_child("History")->add_child_text (i->string ());
444 BOOST_FOREACH (dcp::EncryptedKDM i, _dkdms) {
445 root->add_child("DKDM")->add_child_text (i.as_xml ());
448 root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
449 root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
452 doc.write_to_file_formatted (path("config.xml").string ());
453 } catch (xmlpp::exception& e) {
454 string s = e.what ();
456 throw FileError (s, path("config.xml"));
461 Config::write_cinemas_xml () const
464 xmlpp::Element* root = doc.create_root_node ("Cinemas");
465 root->add_child("Version")->add_child_text ("1");
467 for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
468 (*i)->as_xml (root->add_child ("Cinema"));
472 doc.write_to_file_formatted (_cinemas_file.string ());
473 } catch (xmlpp::exception& e) {
474 string s = e.what ();
476 throw FileError (s, _cinemas_file);
480 boost::filesystem::path
481 Config::default_directory_or (boost::filesystem::path a) const
483 if (_default_directory.empty()) {
487 boost::system::error_code ec;
488 bool const e = boost::filesystem::exists (_default_directory, ec);
493 return _default_directory;
504 Config::changed (Property what)
510 Config::set_kdm_email_to_default ()
512 _kdm_subject = _("KDM delivery: $CPL_NAME");
515 "Dear Projectionist\n\n"
516 "Please find attached KDMs for $CPL_NAME.\n\n"
517 "Cinema: $CINEMA_NAME\n"
518 "Screen(s): $SCREENS\n\n"
519 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
520 "Best regards,\nDCP-o-matic"
525 Config::reset_kdm_email ()
527 set_kdm_email_to_default ();
532 Config::add_to_history (boost::filesystem::path p)
534 /* Remove existing instances of this path in the history */
535 _history.erase (remove (_history.begin(), _history.end(), p), _history.end ());
537 _history.insert (_history.begin (), p);
538 if (_history.size() > HISTORY_SIZE) {
539 _history.pop_back ();
546 Config::have_existing (string file)
548 return boost::filesystem::exists (path (file, false));
552 Config::read_cinemas (cxml::Document const & f)
555 list<cxml::NodePtr> cin = f.node_children ("Cinema");
556 for (list<cxml::NodePtr>::iterator i = cin.begin(); i != cin.end(); ++i) {
557 /* Slightly grotty two-part construction of Cinema here so that we can use
560 shared_ptr<Cinema> cinema (new Cinema (*i));
561 cinema->read_screens (*i);
562 _cinemas.push_back (cinema);
567 Config::set_cinemas_file (boost::filesystem::path file)
569 _cinemas_file = file;
571 if (boost::filesystem::exists (_cinemas_file)) {
572 /* Existing file; read it in */
573 cxml::Document f ("Cinemas");
574 f.read_file (_cinemas_file);