2 Copyright (C) 2012-2015 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.
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>
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;
93 _kdm_subject = _("KDM delivery");
97 _check_for_updates = false;
98 _check_for_test_updates = false;
99 _maximum_j2k_bandwidth = 250000000;
100 _log_types = Log::TYPE_GENERAL | Log::TYPE_WARNING | Log::TYPE_ERROR;
101 _automatic_audio_analysis = false;
102 #ifdef DCPOMATIC_WINDOWS
103 _win32_console = false;
106 _allowed_dcp_frame_rates.clear ();
107 _allowed_dcp_frame_rates.push_back (24);
108 _allowed_dcp_frame_rates.push_back (25);
109 _allowed_dcp_frame_rates.push_back (30);
110 _allowed_dcp_frame_rates.push_back (48);
111 _allowed_dcp_frame_rates.push_back (50);
112 _allowed_dcp_frame_rates.push_back (60);
114 set_kdm_email_to_default ();
118 Config::restore_defaults ()
120 Config::instance()->set_defaults ();
121 Config::instance()->changed ();
127 if (!have_existing ()) {
128 /* Make a new set of signing certificates and key */
129 _signer_chain.reset (new dcp::CertificateChain (openssl_path ()));
130 /* And similar for decryption of KDMs */
131 _decryption_chain.reset (new dcp::CertificateChain (openssl_path ()));
136 cxml::Document f ("Config");
137 f.read_file (file ());
140 optional<int> version = f.optional_number_child<int> ("Version");
142 _num_local_encoding_threads = f.number_child<int> ("NumLocalEncodingThreads");
143 _default_directory = f.string_child ("DefaultDirectory");
145 boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
147 b = f.optional_number_child<int> ("ServerPortBase");
149 _server_port_base = b.get ();
151 boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
152 _use_any_servers = u.get_value_or (true);
154 list<cxml::NodePtr> servers = f.node_children ("Server");
155 for (list<cxml::NodePtr>::iterator i = servers.begin(); i != servers.end(); ++i) {
156 if ((*i)->node_children("HostName").size() == 1) {
157 _servers.push_back ((*i)->string_child ("HostName"));
159 _servers.push_back ((*i)->content ());
163 _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
164 _tms_protocol = static_cast<Protocol> (f.optional_number_child<int> ("TMSProtocol").get_value_or (static_cast<int> (PROTOCOL_SCP)));
165 _tms_ip = f.string_child ("TMSIP");
166 _tms_path = f.string_child ("TMSPath");
167 _tms_user = f.string_child ("TMSUser");
168 _tms_password = f.string_child ("TMSPassword");
170 c = f.optional_string_child ("SoundProcessor");
172 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
174 c = f.optional_string_child ("CinemaSoundProcessor");
176 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
179 _language = f.optional_string_child ("Language");
181 c = f.optional_string_child ("DefaultContainer");
183 _default_container = Ratio::from_id (c.get ());
186 c = f.optional_string_child ("DefaultDCPContentType");
188 _default_dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
191 if (f.optional_string_child ("DCPMetadataIssuer")) {
192 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
193 } else if (f.optional_string_child ("DCPIssuer")) {
194 _dcp_issuer = f.string_child ("DCPIssuer");
197 _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or ("");
199 if (version && version.get() >= 2) {
200 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
202 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
205 _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
206 _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
207 _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
209 list<cxml::NodePtr> cin = f.node_children ("Cinema");
210 for (list<cxml::NodePtr>::iterator i = cin.begin(); i != cin.end(); ++i) {
211 /* Slightly grotty two-part construction of Cinema here so that we can use
214 shared_ptr<Cinema> cinema (new Cinema (*i));
215 cinema->read_screens (*i);
216 _cinemas.push_back (cinema);
219 _mail_server = f.string_child ("MailServer");
220 _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
221 _mail_user = f.optional_string_child("MailUser").get_value_or ("");
222 _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
223 _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
224 _kdm_from = f.string_child ("KDMFrom");
225 _kdm_cc = f.optional_string_child ("KDMCC").get_value_or ("");
226 _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
227 _kdm_email = f.string_child ("KDMEmail");
229 _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
230 _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
232 _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
233 _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate");
235 _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (Log::TYPE_GENERAL | Log::TYPE_WARNING | Log::TYPE_ERROR);
236 _automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
237 #ifdef DCPOMATIC_WINDOWS
238 _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
241 list<cxml::NodePtr> his = f.node_children ("History");
242 for (list<cxml::NodePtr>::const_iterator i = his.begin(); i != his.end(); ++i) {
243 _history.push_back ((*i)->content ());
246 cxml::NodePtr signer = f.optional_node_child ("Signer");
248 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
249 /* Read the signing certificates and private key in from the config file */
250 BOOST_FOREACH (cxml::NodePtr i, signer->node_children ("Certificate")) {
251 c->add (dcp::Certificate (i->content ()));
253 c->set_key (signer->string_child ("PrivateKey"));
256 /* Make a new set of signing certificates and key */
257 _signer_chain.reset (new dcp::CertificateChain (openssl_path ()));
260 cxml::NodePtr decryption = f.optional_node_child ("Decryption");
262 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
263 BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) {
264 c->add (dcp::Certificate (i->content ()));
266 c->set_key (decryption->string_child ("PrivateKey"));
267 _decryption_chain = c;
269 _decryption_chain.reset (new dcp::CertificateChain (openssl_path ()));
273 /** @return Filename to write configuration to */
274 boost::filesystem::path
275 Config::file (bool create_directories)
277 boost::filesystem::path p;
279 p /= g_get_home_dir ();
282 p /= "com.dcpomatic";
285 p /= g_get_user_config_dir ();
288 boost::system::error_code ec;
289 if (create_directories) {
290 boost::filesystem::create_directories (p, ec);
296 /** @return Singleton instance */
300 if (_instance == 0) {
301 _instance = new Config;
304 } catch (exception& e) {
305 /* configuration load failed; never mind, just
306 stick with the default.
308 cerr << "dcpomatic: warning: configuration did not load (" << e.what() << "); using defaults\n";
310 cerr << "dcpomatic: warning: configuration did not load; using defaults\n";
317 /** Write our configuration to disk */
319 Config::write () const
322 xmlpp::Element* root = doc.create_root_node ("Config");
324 root->add_child("Version")->add_child_text ("2");
325 root->add_child("NumLocalEncodingThreads")->add_child_text (raw_convert<string> (_num_local_encoding_threads));
326 root->add_child("DefaultDirectory")->add_child_text (_default_directory.string ());
327 root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
328 root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
330 for (vector<string>::const_iterator i = _servers.begin(); i != _servers.end(); ++i) {
331 root->add_child("Server")->add_child_text (*i);
334 root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
335 root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (_tms_protocol));
336 root->add_child("TMSIP")->add_child_text (_tms_ip);
337 root->add_child("TMSPath")->add_child_text (_tms_path);
338 root->add_child("TMSUser")->add_child_text (_tms_user);
339 root->add_child("TMSPassword")->add_child_text (_tms_password);
340 if (_cinema_sound_processor) {
341 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
344 root->add_child("Language")->add_child_text (_language.get());
346 if (_default_container) {
347 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
349 if (_default_dcp_content_type) {
350 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
352 root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
353 root->add_child("DCPCreator")->add_child_text (_dcp_creator);
355 _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
357 root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
358 root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
359 root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
361 for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
362 (*i)->as_xml (root->add_child ("Cinema"));
365 root->add_child("MailServer")->add_child_text (_mail_server);
366 root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
367 root->add_child("MailUser")->add_child_text (_mail_user);
368 root->add_child("MailPassword")->add_child_text (_mail_password);
369 root->add_child("KDMSubject")->add_child_text (_kdm_subject);
370 root->add_child("KDMFrom")->add_child_text (_kdm_from);
371 root->add_child("KDMCC")->add_child_text (_kdm_cc);
372 root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
373 root->add_child("KDMEmail")->add_child_text (_kdm_email);
375 root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
376 root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
378 root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
379 root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
380 root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
381 root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
382 #ifdef DCPOMATIC_WINDOWS
383 root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
386 xmlpp::Element* signer = root->add_child ("Signer");
387 BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->root_to_leaf ()) {
388 signer->add_child("Certificate")->add_child_text (i.certificate (true));
390 signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
392 xmlpp::Element* decryption = root->add_child ("Decryption");
393 BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->root_to_leaf ()) {
394 decryption->add_child("Certificate")->add_child_text (i.certificate (true));
396 decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ());
398 for (vector<boost::filesystem::path>::const_iterator i = _history.begin(); i != _history.end(); ++i) {
399 root->add_child("History")->add_child_text (i->string ());
403 doc.write_to_file_formatted (file().string ());
404 } catch (xmlpp::exception& e) {
405 string s = e.what ();
407 throw FileError (s, file ());
411 boost::filesystem::path
412 Config::default_directory_or (boost::filesystem::path a) const
414 if (_default_directory.empty()) {
418 boost::system::error_code ec;
419 bool const e = boost::filesystem::exists (_default_directory, ec);
424 return _default_directory;
435 Config::changed (Property what)
441 Config::set_kdm_email_to_default ()
444 "Dear Projectionist\n\n"
445 "Please find attached KDMs for $CPL_NAME.\n\n"
446 "Cinema: $CINEMA_NAME\n"
447 "Screen(s): $SCREENS\n\n"
448 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
449 "Best regards,\nDCP-o-matic"
454 Config::reset_kdm_email ()
456 set_kdm_email_to_default ();
461 Config::add_to_history (boost::filesystem::path p)
463 /* Remove existing instances of this path in the history */
464 _history.erase (remove (_history.begin(), _history.end(), p), _history.end ());
466 _history.insert (_history.begin (), p);
467 if (_history.size() > HISTORY_SIZE) {
468 _history.pop_back ();
475 Config::have_existing ()
477 return boost::filesystem::exists (file (false));