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/colour_matrix.h>
36 #include <dcp/certificate_chain.h>
37 #include <libcxml/cxml.h>
39 #include <libxml++/libxml++.h>
40 #include <boost/filesystem.hpp>
41 #include <boost/algorithm/string.hpp>
42 #include <boost/foreach.hpp>
43 #include <boost/thread.hpp>
59 using boost::shared_ptr;
60 using boost::optional;
61 using boost::algorithm::trim;
62 using dcp::raw_convert;
64 Config* Config::_instance = 0;
65 boost::signals2::signal<void ()> Config::FailedToLoad;
67 /** Construct default configuration */
74 Config::set_defaults ()
76 _num_local_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
77 _server_port_base = 6192;
78 _use_any_servers = true;
80 _only_servers_encode = false;
81 _tms_protocol = PROTOCOL_SCP;
86 _cinema_sound_processor = CinemaSoundProcessor::from_id (N_("dolby_cp750"));
87 _allow_any_dcp_frame_rate = false;
88 _language = optional<string> ();
89 _default_still_length = 10;
90 _default_container = Ratio::from_id ("185");
91 _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
92 _default_dcp_audio_channels = 6;
93 _default_j2k_bandwidth = 100000000;
94 _default_audio_delay = 0;
95 _default_interop = false;
103 _check_for_updates = false;
104 _check_for_test_updates = false;
105 _maximum_j2k_bandwidth = 250000000;
106 _log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR;
107 _analyse_ebur128 = true;
108 _automatic_audio_analysis = false;
109 #ifdef DCPOMATIC_WINDOWS
110 _win32_console = false;
112 _cinemas_file = path ("cinemas.xml");
113 _show_hints_before_make_dcp = 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.string_child ("DefaultDirectory");
164 boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
166 b = f.optional_number_child<int> ("ServerPortBase");
168 _server_port_base = b.get ();
170 boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
171 _use_any_servers = u.get_value_or (true);
173 list<cxml::NodePtr> servers = f.node_children ("Server");
174 for (list<cxml::NodePtr>::iterator i = servers.begin(); i != servers.end(); ++i) {
175 if ((*i)->node_children("HostName").size() == 1) {
176 _servers.push_back ((*i)->string_child ("HostName"));
178 _servers.push_back ((*i)->content ());
182 _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
183 _tms_protocol = static_cast<Protocol> (f.optional_number_child<int> ("TMSProtocol").get_value_or (static_cast<int> (PROTOCOL_SCP)));
184 _tms_ip = f.string_child ("TMSIP");
185 _tms_path = f.string_child ("TMSPath");
186 _tms_user = f.string_child ("TMSUser");
187 _tms_password = f.string_child ("TMSPassword");
189 c = f.optional_string_child ("SoundProcessor");
191 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
193 c = f.optional_string_child ("CinemaSoundProcessor");
195 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
198 _language = f.optional_string_child ("Language");
200 c = f.optional_string_child ("DefaultContainer");
202 _default_container = Ratio::from_id (c.get ());
205 c = f.optional_string_child ("DefaultDCPContentType");
207 _default_dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
210 _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
212 if (f.optional_string_child ("DCPMetadataIssuer")) {
213 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
214 } else if (f.optional_string_child ("DCPIssuer")) {
215 _dcp_issuer = f.string_child ("DCPIssuer");
218 _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
220 if (version && version.get() >= 2) {
221 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
223 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
226 _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
227 _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
228 _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
229 _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
231 /* Load any cinemas from config.xml */
234 _mail_server = f.string_child ("MailServer");
235 _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
236 _mail_user = f.optional_string_child("MailUser").get_value_or ("");
237 _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
238 _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
239 _kdm_from = f.string_child ("KDMFrom");
240 BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("KDMCC")) {
241 if (!i->content().empty()) {
242 _kdm_cc.push_back (i->content ());
245 _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
246 _kdm_email = f.string_child ("KDMEmail");
248 _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
249 _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
251 _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
252 _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
254 _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
255 _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
256 _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
257 #ifdef DCPOMATIC_WINDOWS
258 _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
261 list<cxml::NodePtr> his = f.node_children ("History");
262 for (list<cxml::NodePtr>::const_iterator i = his.begin(); i != his.end(); ++i) {
263 _history.push_back ((*i)->content ());
266 cxml::NodePtr signer = f.optional_node_child ("Signer");
268 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
269 /* Read the signing certificates and private key in from the config file */
270 BOOST_FOREACH (cxml::NodePtr i, signer->node_children ("Certificate")) {
271 c->add (dcp::Certificate (i->content ()));
273 c->set_key (signer->string_child ("PrivateKey"));
276 /* Make a new set of signing certificates and key */
277 _signer_chain = create_certificate_chain ();
280 cxml::NodePtr decryption = f.optional_node_child ("Decryption");
282 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
283 BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) {
284 c->add (dcp::Certificate (i->content ()));
286 c->set_key (decryption->string_child ("PrivateKey"));
287 _decryption_chain = c;
289 _decryption_chain = create_certificate_chain ();
292 list<cxml::NodePtr> dkdm = f.node_children ("DKDM");
293 BOOST_FOREACH (cxml::NodePtr i, f.node_children ("DKDM")) {
294 _dkdms.push_back (dcp::EncryptedKDM (i->content ()));
297 _cinemas_file = f.optional_string_child("CinemasFile").get_value_or (path ("cinemas.xml").string ());
298 _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
299 _kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
300 _dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t"));
301 _dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t"));
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 if (have_existing ("config.xml")) {
312 /* We have a config file but it didn't load */
316 /* Make a new set of signing certificates and key */
317 _signer_chain = create_certificate_chain ();
318 /* And similar for decryption of KDMs */
319 _decryption_chain = create_certificate_chain ();
324 /** @return Filename to write configuration to */
325 boost::filesystem::path
326 Config::path (string file, bool create_directories)
328 boost::filesystem::path p;
330 p /= g_get_home_dir ();
333 p /= "com.dcpomatic";
336 p /= g_get_user_config_dir ();
339 boost::system::error_code ec;
340 if (create_directories) {
341 boost::filesystem::create_directories (p, ec);
347 /** @return Singleton instance */
351 if (_instance == 0) {
352 _instance = new Config;
359 /** Write our configuration to disk */
361 Config::write () const
364 write_cinemas_xml ();
368 Config::write_config_xml () const
371 xmlpp::Element* root = doc.create_root_node ("Config");
373 root->add_child("Version")->add_child_text ("2");
374 root->add_child("NumLocalEncodingThreads")->add_child_text (raw_convert<string> (_num_local_encoding_threads));
375 root->add_child("DefaultDirectory")->add_child_text (_default_directory.string ());
376 root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
377 root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
379 for (vector<string>::const_iterator i = _servers.begin(); i != _servers.end(); ++i) {
380 root->add_child("Server")->add_child_text (*i);
383 root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
384 root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
385 root->add_child("TMSIP")->add_child_text (_tms_ip);
386 root->add_child("TMSPath")->add_child_text (_tms_path);
387 root->add_child("TMSUser")->add_child_text (_tms_user);
388 root->add_child("TMSPassword")->add_child_text (_tms_password);
389 if (_cinema_sound_processor) {
390 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
393 root->add_child("Language")->add_child_text (_language.get());
395 if (_default_container) {
396 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
398 if (_default_dcp_content_type) {
399 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
401 root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
402 root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
403 root->add_child("DCPCreator")->add_child_text (_dcp_creator);
405 _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
407 root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
408 root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
409 root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
410 root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
411 root->add_child("MailServer")->add_child_text (_mail_server);
412 root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
413 root->add_child("MailUser")->add_child_text (_mail_user);
414 root->add_child("MailPassword")->add_child_text (_mail_password);
415 root->add_child("KDMSubject")->add_child_text (_kdm_subject);
416 root->add_child("KDMFrom")->add_child_text (_kdm_from);
417 BOOST_FOREACH (string i, _kdm_cc) {
418 root->add_child("KDMCC")->add_child_text (i);
420 root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
421 root->add_child("KDMEmail")->add_child_text (_kdm_email);
423 root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
424 root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
426 root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
427 root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
428 root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
429 root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
430 root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
431 #ifdef DCPOMATIC_WINDOWS
432 root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
435 xmlpp::Element* signer = root->add_child ("Signer");
436 DCPOMATIC_ASSERT (_signer_chain);
437 BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->root_to_leaf ()) {
438 signer->add_child("Certificate")->add_child_text (i.certificate (true));
440 signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
442 xmlpp::Element* decryption = root->add_child ("Decryption");
443 DCPOMATIC_ASSERT (_decryption_chain);
444 BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->root_to_leaf ()) {
445 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
447 decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
449 for (vector<boost::filesystem::path>::const_iterator i = _history.begin(); i != _history.end(); ++i) {
450 root->add_child("History")->add_child_text (i->string ());
453 BOOST_FOREACH (dcp::EncryptedKDM i, _dkdms) {
454 root->add_child("DKDM")->add_child_text (i.as_xml ());
457 root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
458 root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
459 root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
460 root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ());
461 root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ());
464 doc.write_to_file_formatted (path("config.xml").string ());
465 } catch (xmlpp::exception& e) {
466 string s = e.what ();
468 throw FileError (s, path("config.xml"));
473 Config::write_cinemas_xml () const
476 xmlpp::Element* root = doc.create_root_node ("Cinemas");
477 root->add_child("Version")->add_child_text ("1");
479 for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
480 (*i)->as_xml (root->add_child ("Cinema"));
484 doc.write_to_file_formatted (_cinemas_file.string ());
485 } catch (xmlpp::exception& e) {
486 string s = e.what ();
488 throw FileError (s, _cinemas_file);
492 boost::filesystem::path
493 Config::default_directory_or (boost::filesystem::path a) const
495 if (_default_directory.empty()) {
499 boost::system::error_code ec;
500 bool const e = boost::filesystem::exists (_default_directory, ec);
505 return _default_directory;
516 Config::changed (Property what)
522 Config::set_kdm_email_to_default ()
524 _kdm_subject = _("KDM delivery: $CPL_NAME");
527 "Dear Projectionist\n\n"
528 "Please find attached KDMs for $CPL_NAME.\n\n"
529 "Cinema: $CINEMA_NAME\n"
530 "Screen(s): $SCREENS\n\n"
531 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
532 "Best regards,\nDCP-o-matic"
537 Config::reset_kdm_email ()
539 set_kdm_email_to_default ();
544 Config::add_to_history (boost::filesystem::path p)
546 /* Remove existing instances of this path in the history */
547 _history.erase (remove (_history.begin(), _history.end(), p), _history.end ());
549 _history.insert (_history.begin (), p);
550 if (_history.size() > HISTORY_SIZE) {
551 _history.pop_back ();
558 Config::have_existing (string file)
560 return boost::filesystem::exists (path (file, false));
564 Config::read_cinemas (cxml::Document const & f)
567 list<cxml::NodePtr> cin = f.node_children ("Cinema");
568 for (list<cxml::NodePtr>::iterator i = cin.begin(); i != cin.end(); ++i) {
569 /* Slightly grotty two-part construction of Cinema here so that we can use
572 shared_ptr<Cinema> cinema (new Cinema (*i));
573 cinema->read_screens (*i);
574 _cinemas.push_back (cinema);
579 Config::set_cinemas_file (boost::filesystem::path file)
581 _cinemas_file = file;
583 if (boost::filesystem::exists (_cinemas_file)) {
584 /* Existing file; read it in */
585 cxml::Document f ("Cinemas");
586 f.read_file (_cinemas_file);
594 Config::save_template (shared_ptr<const Film> film, string name) const
596 film->write_template (template_path (name));
600 Config::templates () const
603 for (boost::filesystem::directory_iterator i (path("templates")); i != boost::filesystem::directory_iterator(); ++i) {
604 n.push_back (i->path().filename().string());
610 Config::existing_template (string name) const
612 return boost::filesystem::exists (template_path (name));
615 boost::filesystem::path
616 Config::template_path (string name) const
618 return path("templates") / tidy_for_filename (name);
622 Config::rename_template (string old_name, string new_name) const
624 boost::filesystem::rename (template_path (old_name), template_path (new_name));
628 Config::delete_template (string name) const
630 boost::filesystem::remove (template_path (name));