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.
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 <boost/filesystem.hpp>
37 #include <boost/algorithm/string.hpp>
52 using boost::shared_ptr;
53 using boost::optional;
54 using boost::algorithm::trim;
56 Config* Config::_instance = 0;
58 /** Construct default configuration */
65 Config::set_defaults ()
67 _num_local_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
68 _server_port_base = 6192;
69 _use_any_servers = true;
71 _tms_protocol = PROTOCOL_SCP;
76 _cinema_sound_processor = CinemaSoundProcessor::from_id (N_("dolby_cp750"));
77 _allow_any_dcp_frame_rate = false;
78 _language = optional<string> ();
79 _default_still_length = 10;
80 _default_container = Ratio::from_id ("185");
81 _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
82 _default_j2k_bandwidth = 100000000;
83 _default_audio_delay = 0;
88 _kdm_subject = _("KDM delivery");
92 _check_for_updates = false;
93 _check_for_test_updates = false;
94 _maximum_j2k_bandwidth = 250000000;
95 _log_types = Log::TYPE_GENERAL | Log::TYPE_WARNING | Log::TYPE_ERROR;
96 #ifdef DCPOMATIC_WINDOWS
97 _win32_console = false;
100 _allowed_dcp_frame_rates.clear ();
101 _allowed_dcp_frame_rates.push_back (24);
102 _allowed_dcp_frame_rates.push_back (25);
103 _allowed_dcp_frame_rates.push_back (30);
104 _allowed_dcp_frame_rates.push_back (48);
105 _allowed_dcp_frame_rates.push_back (50);
106 _allowed_dcp_frame_rates.push_back (60);
108 set_kdm_email_to_default ();
112 Config::restore_defaults ()
114 Config::instance()->set_defaults ();
115 Config::instance()->changed ();
121 if (!boost::filesystem::exists (file ())) {
122 /* Make a new set of signing certificates and key */
123 _signer_chain.reset (new dcp::CertificateChain (openssl_path ()));
124 /* And decryption keys */
125 make_decryption_keys ();
129 cxml::Document f ("Config");
130 f.read_file (file ());
133 optional<int> version = f.optional_number_child<int> ("Version");
135 _num_local_encoding_threads = f.number_child<int> ("NumLocalEncodingThreads");
136 _default_directory = f.string_child ("DefaultDirectory");
138 boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
140 b = f.optional_number_child<int> ("ServerPortBase");
142 _server_port_base = b.get ();
144 boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
145 _use_any_servers = u.get_value_or (true);
147 list<cxml::NodePtr> servers = f.node_children ("Server");
148 for (list<cxml::NodePtr>::iterator i = servers.begin(); i != servers.end(); ++i) {
149 if ((*i)->node_children("HostName").size() == 1) {
150 _servers.push_back ((*i)->string_child ("HostName"));
152 _servers.push_back ((*i)->content ());
156 _tms_protocol = static_cast<Protocol> (f.optional_number_child<int> ("TMSProtocol").get_value_or (static_cast<int> (PROTOCOL_SCP)));
157 _tms_ip = f.string_child ("TMSIP");
158 _tms_path = f.string_child ("TMSPath");
159 _tms_user = f.string_child ("TMSUser");
160 _tms_password = f.string_child ("TMSPassword");
162 c = f.optional_string_child ("SoundProcessor");
164 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
166 c = f.optional_string_child ("CinemaSoundProcessor");
168 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
171 _language = f.optional_string_child ("Language");
173 c = f.optional_string_child ("DefaultContainer");
175 _default_container = Ratio::from_id (c.get ());
178 c = f.optional_string_child ("DefaultDCPContentType");
180 _default_dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
183 if (f.optional_string_child ("DCPMetadataIssuer")) {
184 _dcp_issuer = f.string_child ("DCPMetadataIssuer");
185 } else if (f.optional_string_child ("DCPIssuer")) {
186 _dcp_issuer = f.string_child ("DCPIssuer");
189 if (version && version.get() >= 2) {
190 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
192 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
195 _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
196 _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
197 _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
199 list<cxml::NodePtr> cin = f.node_children ("Cinema");
200 for (list<cxml::NodePtr>::iterator i = cin.begin(); i != cin.end(); ++i) {
201 /* Slightly grotty two-part construction of Cinema here so that we can use
204 shared_ptr<Cinema> cinema (new Cinema (*i));
205 cinema->read_screens (*i);
206 _cinemas.push_back (cinema);
209 _mail_server = f.string_child ("MailServer");
210 _mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
211 _mail_user = f.optional_string_child("MailUser").get_value_or ("");
212 _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
213 _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
214 _kdm_from = f.string_child ("KDMFrom");
215 _kdm_cc = f.optional_string_child ("KDMCC").get_value_or ("");
216 _kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
217 _kdm_email = f.string_child ("KDMEmail");
219 _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
220 _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
222 _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
223 _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate");
225 _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (Log::TYPE_GENERAL | Log::TYPE_WARNING | Log::TYPE_ERROR);
226 #ifdef DCPOMATIC_WINDOWS
227 _win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
230 list<cxml::NodePtr> his = f.node_children ("History");
231 for (list<cxml::NodePtr>::const_iterator i = his.begin(); i != his.end(); ++i) {
232 _history.push_back ((*i)->content ());
235 cxml::NodePtr signer = f.optional_node_child ("Signer");
237 shared_ptr<dcp::CertificateChain> c (new dcp::CertificateChain ());
238 /* Read the signing certificates and private key in from the config file */
239 list<cxml::NodePtr> certificates = signer->node_children ("Certificate");
240 for (list<cxml::NodePtr>::const_iterator i = certificates.begin(); i != certificates.end(); ++i) {
241 c->add (dcp::Certificate ((*i)->content ()));
243 c->set_key (signer->string_child ("PrivateKey"));
246 /* Make a new set of signing certificates and key */
247 _signer_chain.reset (new dcp::CertificateChain (openssl_path ()));
250 if (f.optional_string_child ("DecryptionCertificate")) {
251 _decryption_certificate = dcp::Certificate (f.string_child ("DecryptionCertificate"));
254 if (f.optional_string_child ("DecryptionPrivateKey")) {
255 _decryption_private_key = f.string_child ("DecryptionPrivateKey");
258 if (!f.optional_string_child ("DecryptionCertificate") || !f.optional_string_child ("DecryptionPrivateKey")) {
259 /* Generate our own decryption certificate and key if either is not present in config */
260 make_decryption_keys ();
265 Config::make_decryption_keys ()
267 dcp::CertificateChain c (openssl_path ());
268 _decryption_certificate = c.leaf ();
269 _decryption_private_key = c.key().get ();
272 /** @return Filename to write configuration to */
273 boost::filesystem::path
274 Config::file () const
276 boost::filesystem::path p;
278 p /= g_get_home_dir ();
281 p /= "com.dcpomatic";
284 p /= g_get_user_config_dir ();
287 boost::system::error_code ec;
288 boost::filesystem::create_directories (p, ec);
293 /** @return Singleton instance */
297 if (_instance == 0) {
298 _instance = new Config;
301 } catch (exception& e) {
302 /* configuration load failed; never mind, just
303 stick with the default.
305 cerr << "dcpomatic: failed to load configuration (" << e.what() << ")\n";
307 cerr << "dcpomatic: failed to load configuration\n";
314 /** Write our configuration to disk */
316 Config::write () const
319 xmlpp::Element* root = doc.create_root_node ("Config");
321 root->add_child("Version")->add_child_text ("2");
322 root->add_child("NumLocalEncodingThreads")->add_child_text (raw_convert<string> (_num_local_encoding_threads));
323 root->add_child("DefaultDirectory")->add_child_text (_default_directory.string ());
324 root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
325 root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
327 for (vector<string>::const_iterator i = _servers.begin(); i != _servers.end(); ++i) {
328 root->add_child("Server")->add_child_text (*i);
331 root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (_tms_protocol));
332 root->add_child("TMSIP")->add_child_text (_tms_ip);
333 root->add_child("TMSPath")->add_child_text (_tms_path);
334 root->add_child("TMSUser")->add_child_text (_tms_user);
335 root->add_child("TMSPassword")->add_child_text (_tms_password);
336 if (_cinema_sound_processor) {
337 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
340 root->add_child("Language")->add_child_text (_language.get());
342 if (_default_container) {
343 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
345 if (_default_dcp_content_type) {
346 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
348 root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
350 _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
352 root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
353 root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
354 root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
356 for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
357 (*i)->as_xml (root->add_child ("Cinema"));
360 root->add_child("MailServer")->add_child_text (_mail_server);
361 root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
362 root->add_child("MailUser")->add_child_text (_mail_user);
363 root->add_child("MailPassword")->add_child_text (_mail_password);
364 root->add_child("KDMSubject")->add_child_text (_kdm_subject);
365 root->add_child("KDMFrom")->add_child_text (_kdm_from);
366 root->add_child("KDMCC")->add_child_text (_kdm_cc);
367 root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
368 root->add_child("KDMEmail")->add_child_text (_kdm_email);
370 root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
371 root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
373 root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
374 root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
375 root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
376 #ifdef DCPOMATIC_WINDOWS
377 root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
380 xmlpp::Element* signer = root->add_child ("Signer");
381 dcp::CertificateChain::List certs = _signer_chain->root_to_leaf ();
382 for (dcp::CertificateChain::List::const_iterator i = certs.begin(); i != certs.end(); ++i) {
383 signer->add_child("Certificate")->add_child_text (i->certificate (true));
385 signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
387 root->add_child("DecryptionCertificate")->add_child_text (_decryption_certificate.certificate (true));
388 root->add_child("DecryptionPrivateKey")->add_child_text (_decryption_private_key);
390 for (vector<boost::filesystem::path>::const_iterator i = _history.begin(); i != _history.end(); ++i) {
391 root->add_child("History")->add_child_text (i->string ());
395 doc.write_to_file_formatted (file().string ());
396 } catch (xmlpp::exception& e) {
397 string s = e.what ();
399 throw FileError (s, file ());
403 boost::filesystem::path
404 Config::default_directory_or (boost::filesystem::path a) const
406 if (_default_directory.empty()) {
410 boost::system::error_code ec;
411 bool const e = boost::filesystem::exists (_default_directory, ec);
416 return _default_directory;
427 Config::changed (Property what)
433 Config::set_kdm_email_to_default ()
436 "Dear Projectionist\n\n"
437 "Please find attached KDMs for $CPL_NAME.\n\n"
438 "Cinema: $CINEMA_NAME\n"
439 "Screen(s): $SCREENS\n\n"
440 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
441 "Best regards,\nDCP-o-matic"
446 Config::reset_kdm_email ()
448 set_kdm_email_to_default ();
453 Config::add_to_history (boost::filesystem::path p)
455 /* Remove existing instances of this path in the history */
456 _history.erase (remove (_history.begin(), _history.end(), p), _history.end ());
458 _history.insert (_history.begin (), p);
459 if (_history.size() > HISTORY_SIZE) {
460 _history.pop_back ();