2 Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 #include "dcp_content_type.h"
26 #include "cinema_sound_processor.h"
27 #include "colour_conversion.h"
31 #include "raw_convert.h"
32 #include <dcp/colour_matrix.h>
33 #include <dcp/certificate_chain.h>
34 #include <libcxml/cxml.h>
36 #include <libxml++/libxml++.h>
37 #include <boost/filesystem.hpp>
38 #include <boost/algorithm/string.hpp>
39 #include <boost/foreach.hpp>
40 #include <boost/thread.hpp>
56 using boost::shared_ptr;
57 using boost::optional;
58 using boost::algorithm::trim;
60 Config* Config::_instance = 0;
62 /** Construct default configuration */
69 Config::set_defaults ()
71 _num_local_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
72 _server_port_base = 6192;
73 _use_any_servers = true;
75 _only_servers_encode = false;
76 _tms_protocol = PROTOCOL_SCP;
81 _cinema_sound_processor = CinemaSoundProcessor::from_id (N_("dolby_cp750"));
82 _allow_any_dcp_frame_rate = false;
83 _language = optional<string> ();
84 _default_still_length = 10;
85 _default_container = Ratio::from_id ("185");
86 _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
87 _default_j2k_bandwidth = 100000000;
88 _default_audio_delay = 0;
89 _default_interop = false;
97 _check_for_updates = false;
98 _check_for_test_updates = false;
99 _maximum_j2k_bandwidth = 250000000;
100 _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR;
101 _analyse_ebur128 = true;
102 _automatic_audio_analysis = false;
103 #ifdef DCPOMATIC_WINDOWS
104 _win32_console = false;
106 _cinemas_file = path ("cinemas.xml");
108 _allowed_dcp_frame_rates.clear ();
109 _allowed_dcp_frame_rates.push_back (24);
110 _allowed_dcp_frame_rates.push_back (25);
111 _allowed_dcp_frame_rates.push_back (30);
112 _allowed_dcp_frame_rates.push_back (48);
113 _allowed_dcp_frame_rates.push_back (50);
114 _allowed_dcp_frame_rates.push_back (60);
116 set_kdm_email_to_default ();
120 Config::restore_defaults ()
122 Config::instance()->set_defaults ();
123 Config::instance()->changed ();
126 shared_ptr<dcp::CertificateChain>
127 Config::create_certificate_chain ()
129 return shared_ptr<dcp::CertificateChain> (
130 new dcp::CertificateChain (
134 ".dcpomatic.smpte-430-2.ROOT",
135 ".dcpomatic.smpte-430-2.INTERMEDIATE",
136 "CS.dcpomatic.smpte-430-2.LEAF"
144 if (!have_existing ("config.xml")) {
145 /* Make a new set of signing certificates and key */
146 _signer_chain = create_certificate_chain ();
147 /* And similar for decryption of KDMs */
148 _decryption_chain = create_certificate_chain ();
153 cxml::Document f ("Config");
154 f.read_file (path ("config.xml"));
157 optional<int> version = f.optional_number_child<int> ("Version");
159 _num_local_encoding_threads = f.number_child<int> ("NumLocalEncodingThreads");
160 _default_directory = f.string_child ("DefaultDirectory");
162 boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
164 b = f.optional_number_child<int> ("ServerPortBase");
166 _server_port_base = b.get ();
168 boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
169 _use_any_servers = u.get_value_or (true);
171 list<cxml::NodePtr> servers = f.node_children ("Server");
172 for (list<cxml::NodePtr>::iterator i = servers.begin(); i != servers.end(); ++i) {
173 if ((*i)->node_children("HostName").size() == 1) {
174 _servers.push_back ((*i)->string_child ("HostName"));
176 _servers.push_back ((*i)->content ());
180 _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
181 _tms_protocol = static_cast<Protocol> (f.optional_number_child<int> ("TMSProtocol").get_value_or (static_cast<int> (PROTOCOL_SCP)));
182 _tms_ip = f.string_child ("TMSIP");
183 _tms_path = f.string_child ("TMSPath");
184 _tms_user = f.string_child ("TMSUser");
185 _tms_password = f.string_child ("TMSPassword");
187 c = f.optional_string_child ("SoundProcessor");
189 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
191 c = f.optional_string_child ("CinemaSoundProcessor");
193 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
196 _language = f.optional_string_child ("Language");
198 c = f.optional_string_child ("DefaultContainer");
200 _default_container = Ratio::from_id (c.get ());
203 c = f.optional_string_child ("DefaultDCPContentType");
205 _default_dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
208 if (f.optional_string_child ("DCPMetadataIssuer")) {
209 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
210 } else if (f.optional_string_child ("DCPIssuer")) {
211 _dcp_issuer = f.string_child ("DCPIssuer");
214 _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
216 if (version && version.get() >= 2) {
217 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
219 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
222 _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
223 _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
224 _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
225 _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
227 /* Load any cinemas from config.xml */
230 _mail_server = f.string_child ("MailServer");
231 _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
232 _mail_user = f.optional_string_child("MailUser").get_value_or ("");
233 _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
234 _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
235 _kdm_from = f.string_child ("KDMFrom");
236 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("KDMCC")) {
237 if (!i->content().empty()) {
238 _kdm_cc.push_back (i->content ());
241 _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
242 _kdm_email = f.string_child ("KDMEmail");
244 _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
245 _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
247 _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
248 _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
250 _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
251 _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
252 _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
253 #ifdef DCPOMATIC_WINDOWS
254 _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
257 list<cxml::NodePtr> his = f.node_children ("History");
258 for (list<cxml::NodePtr>::const_iterator i = his.begin(); i != his.end(); ++i) {
259 _history.push_back ((*i)->content ());
262 cxml::NodePtr signer = f.optional_node_child ("Signer");
264 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
265 /* Read the signing certificates and private key in from the config file */
266 BOOST_FOREACH (cxml::NodePtr i, signer->node_children ("Certificate")) {
267 c->add (dcp::Certificate (i->content ()));
269 c->set_key (signer->string_child ("PrivateKey"));
272 /* Make a new set of signing certificates and key */
273 _signer_chain = create_certificate_chain ();
276 cxml::NodePtr decryption = f.optional_node_child ("Decryption");
278 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
279 BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) {
280 c->add (dcp::Certificate (i->content ()));
282 c->set_key (decryption->string_child ("PrivateKey"));
283 _decryption_chain = c;
285 _decryption_chain = create_certificate_chain ();
288 list<cxml::NodePtr> dkdm = f.node_children ("DKDM");
289 BOOST_FOREACH (cxml::NodePtr i, f.node_children ("DKDM")) {
290 _dkdms.push_back (dcp::EncryptedKDM (i->content ()));
293 _cinemas_file = f.optional_string_child("CinemasFile").get_value_or (path ("cinemas.xml").string ());
295 /* Replace any cinemas from config.xml with those from the configured file */
296 if (boost::filesystem::exists (_cinemas_file)) {
297 cxml::Document f ("Cinemas");
298 f.read_file (_cinemas_file);
303 /** @return Filename to write configuration to */
304 boost::filesystem::path
305 Config::path (string file, bool create_directories)
307 boost::filesystem::path p;
309 p /= g_get_home_dir ();
312 p /= "com.dcpomatic";
315 p /= g_get_user_config_dir ();
318 boost::system::error_code ec;
319 if (create_directories) {
320 boost::filesystem::create_directories (p, ec);
326 /** @return Singleton instance */
330 if (_instance == 0) {
331 _instance = new Config;
334 } catch (exception& e) {
335 /* configuration load failed; never mind, just
336 stick with the default.
338 cerr << "dcpomatic: warning: configuration did not load (" << e.what() << "); using defaults\n";
340 cerr << "dcpomatic: warning: configuration did not load; using defaults\n";
347 /** Write our configuration to disk */
349 Config::write () const
352 write_cinemas_xml ();
356 Config::write_config_xml () const
359 xmlpp::Element* root = doc.create_root_node ("Config");
361 root->add_child("Version")->add_child_text ("2");
362 root->add_child("NumLocalEncodingThreads")->add_child_text (raw_convert<string> (_num_local_encoding_threads));
363 root->add_child("DefaultDirectory")->add_child_text (_default_directory.string ());
364 root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
365 root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
367 for (vector<string>::const_iterator i = _servers.begin(); i != _servers.end(); ++i) {
368 root->add_child("Server")->add_child_text (*i);
371 root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
372 root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (_tms_protocol));
373 root->add_child("TMSIP")->add_child_text (_tms_ip);
374 root->add_child("TMSPath")->add_child_text (_tms_path);
375 root->add_child("TMSUser")->add_child_text (_tms_user);
376 root->add_child("TMSPassword")->add_child_text (_tms_password);
377 if (_cinema_sound_processor) {
378 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
381 root->add_child("Language")->add_child_text (_language.get());
383 if (_default_container) {
384 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
386 if (_default_dcp_content_type) {
387 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
389 root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
390 root->add_child("DCPCreator")->add_child_text (_dcp_creator);
392 _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
394 root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
395 root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
396 root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
397 root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
398 root->add_child("MailServer")->add_child_text (_mail_server);
399 root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
400 root->add_child("MailUser")->add_child_text (_mail_user);
401 root->add_child("MailPassword")->add_child_text (_mail_password);
402 root->add_child("KDMSubject")->add_child_text (_kdm_subject);
403 root->add_child("KDMFrom")->add_child_text (_kdm_from);
404 BOOST_FOREACH (string i, _kdm_cc) {
405 root->add_child("KDMCC")->add_child_text (i);
407 root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
408 root->add_child("KDMEmail")->add_child_text (_kdm_email);
410 root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
411 root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
413 root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
414 root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
415 root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
416 root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
417 root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
418 #ifdef DCPOMATIC_WINDOWS
419 root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
422 xmlpp::Element* signer = root->add_child ("Signer");
423 DCPOMATIC_ASSERT (_signer_chain);
424 BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->root_to_leaf ()) {
425 signer->add_child("Certificate")->add_child_text (i.certificate (true));
427 signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
429 xmlpp::Element* decryption = root->add_child ("Decryption");
430 DCPOMATIC_ASSERT (_decryption_chain);
431 BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->root_to_leaf ()) {
432 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
434 decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
436 for (vector<boost::filesystem::path>::const_iterator i = _history.begin(); i != _history.end(); ++i) {
437 root->add_child("History")->add_child_text (i->string ());
440 BOOST_FOREACH (dcp::EncryptedKDM i, _dkdms) {
441 root->add_child("DKDM")->add_child_text (i.as_xml ());
444 root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
447 doc.write_to_file_formatted (path("config.xml").string ());
448 } catch (xmlpp::exception& e) {
449 string s = e.what ();
451 throw FileError (s, path("config.xml"));
456 Config::write_cinemas_xml () const
459 xmlpp::Element* root = doc.create_root_node ("Cinemas");
460 root->add_child("Version")->add_child_text ("1");
462 for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
463 (*i)->as_xml (root->add_child ("Cinema"));
467 doc.write_to_file_formatted (_cinemas_file.string ());
468 } catch (xmlpp::exception& e) {
469 string s = e.what ();
471 throw FileError (s, _cinemas_file);
475 boost::filesystem::path
476 Config::default_directory_or (boost::filesystem::path a) const
478 if (_default_directory.empty()) {
482 boost::system::error_code ec;
483 bool const e = boost::filesystem::exists (_default_directory, ec);
488 return _default_directory;
499 Config::changed (Property what)
505 Config::set_kdm_email_to_default ()
507 _kdm_subject = _("KDM delivery: $CPL_NAME");
510 "Dear Projectionist\n\n"
511 "Please find attached KDMs for $CPL_NAME.\n\n"
512 "Cinema: $CINEMA_NAME\n"
513 "Screen(s): $SCREENS\n\n"
514 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
515 "Best regards,\nDCP-o-matic"
520 Config::reset_kdm_email ()
522 set_kdm_email_to_default ();
527 Config::add_to_history (boost::filesystem::path p)
529 /* Remove existing instances of this path in the history */
530 _history.erase (remove (_history.begin(), _history.end(), p), _history.end ());
532 _history.insert (_history.begin (), p);
533 if (_history.size() > HISTORY_SIZE) {
534 _history.pop_back ();
541 Config::have_existing (string file)
543 return boost::filesystem::exists (path (file, false));
547 Config::read_cinemas (cxml::Document const & f)
550 list<cxml::NodePtr> cin = f.node_children ("Cinema");
551 for (list<cxml::NodePtr>::iterator i = cin.begin(); i != cin.end(); ++i) {
552 /* Slightly grotty two-part construction of Cinema here so that we can use
555 shared_ptr<Cinema> cinema (new Cinema (*i));
556 cinema->read_screens (*i);
557 _cinemas.push_back (cinema);
562 Config::set_cinemas_file (boost::filesystem::path file)
564 _cinemas_file = file;
566 if (boost::filesystem::exists (_cinemas_file)) {
567 /* Existing file; read it in */
568 cxml::Document f ("Cinemas");
569 f.read_file (_cinemas_file);