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;
63 /** Construct default configuration */
70 Config::set_defaults ()
72 _num_local_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
73 _server_port_base = 6192;
74 _use_any_servers = true;
76 _only_servers_encode = false;
77 _tms_protocol = PROTOCOL_SCP;
82 _cinema_sound_processor = CinemaSoundProcessor::from_id (N_("dolby_cp750"));
83 _allow_any_dcp_frame_rate = false;
84 _language = optional<string> ();
85 _default_still_length = 10;
86 _default_container = Ratio::from_id ("185");
87 _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
88 _default_dcp_audio_channels = 6;
89 _default_j2k_bandwidth = 100000000;
90 _default_audio_delay = 0;
91 _default_interop = false;
99 _check_for_updates = false;
100 _check_for_test_updates = false;
101 _maximum_j2k_bandwidth = 250000000;
102 _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR;
103 _analyse_ebur128 = true;
104 _automatic_audio_analysis = false;
105 #ifdef DCPOMATIC_WINDOWS
106 _win32_console = false;
108 _cinemas_file = path ("cinemas.xml");
109 _show_hints_before_make_dcp = true;
111 _allowed_dcp_frame_rates.clear ();
112 _allowed_dcp_frame_rates.push_back (24);
113 _allowed_dcp_frame_rates.push_back (25);
114 _allowed_dcp_frame_rates.push_back (30);
115 _allowed_dcp_frame_rates.push_back (48);
116 _allowed_dcp_frame_rates.push_back (50);
117 _allowed_dcp_frame_rates.push_back (60);
119 set_kdm_email_to_default ();
123 Config::restore_defaults ()
125 Config::instance()->set_defaults ();
126 Config::instance()->changed ();
129 shared_ptr<dcp::CertificateChain>
130 Config::create_certificate_chain ()
132 return shared_ptr<dcp::CertificateChain> (
133 new dcp::CertificateChain (
137 ".dcpomatic.smpte-430-2.ROOT",
138 ".dcpomatic.smpte-430-2.INTERMEDIATE",
139 "CS.dcpomatic.smpte-430-2.LEAF"
147 if (!have_existing ("config.xml")) {
148 cout << "No existing config.xml; creating chains.\n";
149 /* Make a new set of signing certificates and key */
150 _signer_chain = create_certificate_chain ();
151 /* And similar for decryption of KDMs */
152 _decryption_chain = create_certificate_chain ();
153 cout << "Writing config.\n";
158 cxml::Document f ("Config");
159 f.read_file (path ("config.xml"));
162 optional<int> version = f.optional_number_child<int> ("Version");
164 _num_local_encoding_threads = f.number_child<int> ("NumLocalEncodingThreads");
165 _default_directory = f.string_child ("DefaultDirectory");
167 boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
169 b = f.optional_number_child<int> ("ServerPortBase");
171 _server_port_base = b.get ();
173 boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
174 _use_any_servers = u.get_value_or (true);
176 list<cxml::NodePtr> servers = f.node_children ("Server");
177 for (list<cxml::NodePtr>::iterator i = servers.begin(); i != servers.end(); ++i) {
178 if ((*i)->node_children("HostName").size() == 1) {
179 _servers.push_back ((*i)->string_child ("HostName"));
181 _servers.push_back ((*i)->content ());
185 _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
186 _tms_protocol = static_cast<Protocol> (f.optional_number_child<int> ("TMSProtocol").get_value_or (static_cast<int> (PROTOCOL_SCP)));
187 _tms_ip = f.string_child ("TMSIP");
188 _tms_path = f.string_child ("TMSPath");
189 _tms_user = f.string_child ("TMSUser");
190 _tms_password = f.string_child ("TMSPassword");
192 c = f.optional_string_child ("SoundProcessor");
194 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
196 c = f.optional_string_child ("CinemaSoundProcessor");
198 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
201 _language = f.optional_string_child ("Language");
203 c = f.optional_string_child ("DefaultContainer");
205 _default_container = Ratio::from_id (c.get ());
208 c = f.optional_string_child ("DefaultDCPContentType");
210 _default_dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
213 _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
215 if (f.optional_string_child ("DCPMetadataIssuer")) {
216 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
217 } else if (f.optional_string_child ("DCPIssuer")) {
218 _dcp_issuer = f.string_child ("DCPIssuer");
221 _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
223 if (version && version.get() >= 2) {
224 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
226 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
229 _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
230 _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
231 _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
232 _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
234 /* Load any cinemas from config.xml */
237 _mail_server = f.string_child ("MailServer");
238 _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
239 _mail_user = f.optional_string_child("MailUser").get_value_or ("");
240 _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
241 _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
242 _kdm_from = f.string_child ("KDMFrom");
243 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("KDMCC")) {
244 if (!i->content().empty()) {
245 _kdm_cc.push_back (i->content ());
248 _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
249 _kdm_email = f.string_child ("KDMEmail");
251 _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
252 _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
254 _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
255 _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
257 _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
258 _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
259 _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
260 #ifdef DCPOMATIC_WINDOWS
261 _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
264 list<cxml::NodePtr> his = f.node_children ("History");
265 for (list<cxml::NodePtr>::const_iterator i = his.begin(); i != his.end(); ++i) {
266 _history.push_back ((*i)->content ());
269 cxml::NodePtr signer = f.optional_node_child ("Signer");
271 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
272 /* Read the signing certificates and private key in from the config file */
273 BOOST_FOREACH (cxml::NodePtr i, signer->node_children ("Certificate")) {
274 c->add (dcp::Certificate (i->content ()));
276 c->set_key (signer->string_child ("PrivateKey"));
279 /* Make a new set of signing certificates and key */
280 _signer_chain = create_certificate_chain ();
283 cxml::NodePtr decryption = f.optional_node_child ("Decryption");
285 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
286 BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) {
287 c->add (dcp::Certificate (i->content ()));
289 c->set_key (decryption->string_child ("PrivateKey"));
290 _decryption_chain = c;
292 _decryption_chain = create_certificate_chain ();
295 list<cxml::NodePtr> dkdm = f.node_children ("DKDM");
296 BOOST_FOREACH (cxml::NodePtr i, f.node_children ("DKDM")) {
297 _dkdms.push_back (dcp::EncryptedKDM (i->content ()));
300 _cinemas_file = f.optional_string_child("CinemasFile").get_value_or (path ("cinemas.xml").string ());
301 _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
303 /* Replace any cinemas from config.xml with those from the configured file */
304 if (boost::filesystem::exists (_cinemas_file)) {
305 cxml::Document f ("Cinemas");
306 f.read_file (_cinemas_file);
311 /** @return Filename to write configuration to */
312 boost::filesystem::path
313 Config::path (string file, bool create_directories)
315 boost::filesystem::path p;
317 p /= g_get_home_dir ();
320 p /= "com.dcpomatic";
323 p /= g_get_user_config_dir ();
326 boost::system::error_code ec;
327 if (create_directories) {
328 boost::filesystem::create_directories (p, ec);
334 /** @return Singleton instance */
338 if (_instance == 0) {
339 _instance = new Config;
342 } catch (exception& e) {
343 /* configuration load failed; never mind, just
344 stick with the default.
346 cerr << "dcpomatic: warning: configuration did not load (" << e.what() << "); using defaults\n";
348 cerr << "dcpomatic: warning: configuration did not load; using defaults\n";
355 /** Write our configuration to disk */
357 Config::write () const
360 write_cinemas_xml ();
364 Config::write_config_xml () const
367 xmlpp::Element* root = doc.create_root_node ("Config");
369 root->add_child("Version")->add_child_text ("2");
370 root->add_child("NumLocalEncodingThreads")->add_child_text (raw_convert<string> (_num_local_encoding_threads));
371 root->add_child("DefaultDirectory")->add_child_text (_default_directory.string ());
372 root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
373 root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
375 for (vector<string>::const_iterator i = _servers.begin(); i != _servers.end(); ++i) {
376 root->add_child("Server")->add_child_text (*i);
379 root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
380 root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (_tms_protocol));
381 root->add_child("TMSIP")->add_child_text (_tms_ip);
382 root->add_child("TMSPath")->add_child_text (_tms_path);
383 root->add_child("TMSUser")->add_child_text (_tms_user);
384 root->add_child("TMSPassword")->add_child_text (_tms_password);
385 if (_cinema_sound_processor) {
386 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
389 root->add_child("Language")->add_child_text (_language.get());
391 if (_default_container) {
392 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
394 if (_default_dcp_content_type) {
395 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
397 root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
398 root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
399 root->add_child("DCPCreator")->add_child_text (_dcp_creator);
401 _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
403 root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
404 root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
405 root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
406 root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
407 root->add_child("MailServer")->add_child_text (_mail_server);
408 root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
409 root->add_child("MailUser")->add_child_text (_mail_user);
410 root->add_child("MailPassword")->add_child_text (_mail_password);
411 root->add_child("KDMSubject")->add_child_text (_kdm_subject);
412 root->add_child("KDMFrom")->add_child_text (_kdm_from);
413 BOOST_FOREACH (string i, _kdm_cc) {
414 root->add_child("KDMCC")->add_child_text (i);
416 root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
417 root->add_child("KDMEmail")->add_child_text (_kdm_email);
419 root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
420 root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
422 root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
423 root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
424 root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
425 root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
426 root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
427 #ifdef DCPOMATIC_WINDOWS
428 root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
431 xmlpp::Element* signer = root->add_child ("Signer");
432 DCPOMATIC_ASSERT (_signer_chain);
433 BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->root_to_leaf ()) {
434 signer->add_child("Certificate")->add_child_text (i.certificate (true));
436 signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
438 xmlpp::Element* decryption = root->add_child ("Decryption");
439 DCPOMATIC_ASSERT (_decryption_chain);
440 BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->root_to_leaf ()) {
441 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
443 decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
445 for (vector<boost::filesystem::path>::const_iterator i = _history.begin(); i != _history.end(); ++i) {
446 root->add_child("History")->add_child_text (i->string ());
449 BOOST_FOREACH (dcp::EncryptedKDM i, _dkdms) {
450 root->add_child("DKDM")->add_child_text (i.as_xml ());
453 root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
454 root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
457 doc.write_to_file_formatted (path("config.xml").string ());
458 } catch (xmlpp::exception& e) {
459 string s = e.what ();
461 throw FileError (s, path("config.xml"));
466 Config::write_cinemas_xml () const
469 xmlpp::Element* root = doc.create_root_node ("Cinemas");
470 root->add_child("Version")->add_child_text ("1");
472 for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
473 (*i)->as_xml (root->add_child ("Cinema"));
477 doc.write_to_file_formatted (_cinemas_file.string ());
478 } catch (xmlpp::exception& e) {
479 string s = e.what ();
481 throw FileError (s, _cinemas_file);
485 boost::filesystem::path
486 Config::default_directory_or (boost::filesystem::path a) const
488 if (_default_directory.empty()) {
492 boost::system::error_code ec;
493 bool const e = boost::filesystem::exists (_default_directory, ec);
498 return _default_directory;
509 Config::changed (Property what)
515 Config::set_kdm_email_to_default ()
517 _kdm_subject = _("KDM delivery: $CPL_NAME");
520 "Dear Projectionist\n\n"
521 "Please find attached KDMs for $CPL_NAME.\n\n"
522 "Cinema: $CINEMA_NAME\n"
523 "Screen(s): $SCREENS\n\n"
524 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
525 "Best regards,\nDCP-o-matic"
530 Config::reset_kdm_email ()
532 set_kdm_email_to_default ();
537 Config::add_to_history (boost::filesystem::path p)
539 /* Remove existing instances of this path in the history */
540 _history.erase (remove (_history.begin(), _history.end(), p), _history.end ());
542 _history.insert (_history.begin (), p);
543 if (_history.size() > HISTORY_SIZE) {
544 _history.pop_back ();
551 Config::have_existing (string file)
553 return boost::filesystem::exists (path (file, false));
557 Config::read_cinemas (cxml::Document const & f)
560 list<cxml::NodePtr> cin = f.node_children ("Cinema");
561 for (list<cxml::NodePtr>::iterator i = cin.begin(); i != cin.end(); ++i) {
562 /* Slightly grotty two-part construction of Cinema here so that we can use
565 shared_ptr<Cinema> cinema (new Cinema (*i));
566 cinema->read_screens (*i);
567 _cinemas.push_back (cinema);
572 Config::set_cinemas_file (boost::filesystem::path file)
574 _cinemas_file = file;
576 if (boost::filesystem::exists (_cinemas_file)) {
577 /* Existing file; read it in */
578 cxml::Document f ("Cinemas");
579 f.read_file (_cinemas_file);