2 Copyright (C) 2012-2014 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.
24 #include <boost/filesystem.hpp>
25 #include <boost/algorithm/string.hpp>
26 #include <libdcp/colour_matrix.h>
27 #include <libcxml/cxml.h>
33 #include "dcp_content_type.h"
34 #include "sound_processor.h"
35 #include "colour_conversion.h"
48 using boost::shared_ptr;
49 using boost::lexical_cast;
50 using boost::optional;
51 using boost::algorithm::is_any_of;
52 using boost::algorithm::split;
54 Config* Config::_instance = 0;
56 /** Construct default configuration */
58 : _num_local_encoding_threads (max (2U, boost::thread::hardware_concurrency()))
59 , _server_port_base (6192)
60 , _use_any_servers (true)
62 , _sound_processor (SoundProcessor::from_id (N_("dolby_cp750")))
63 , _default_still_length (10)
64 , _default_container (Ratio::from_id ("185"))
65 , _default_dcp_content_type (DCPContentType::from_dci_name ("TST"))
66 , _default_j2k_bandwidth (100000000)
67 , _default_audio_delay (0)
69 _("Dear Projectionist\n\nPlease find attached KDMs for $CPL_NAME.\n\nThe KDMs are valid from $START_TIME until $END_TIME.\n\nBest regards,\nDCP-o-matic")
71 , _check_for_updates (false)
72 , _check_for_test_updates (false)
73 , _maximum_j2k_bandwidth (250000000)
75 _allowed_dcp_frame_rates.push_back (24);
76 _allowed_dcp_frame_rates.push_back (25);
77 _allowed_dcp_frame_rates.push_back (30);
78 _allowed_dcp_frame_rates.push_back (48);
79 _allowed_dcp_frame_rates.push_back (50);
80 _allowed_dcp_frame_rates.push_back (60);
82 _colour_conversions.push_back (PresetColourConversion (_("sRGB"), 2.4, true, libdcp::colour_matrix::srgb_to_xyz, 2.6));
83 _colour_conversions.push_back (PresetColourConversion (_("sRGB non-linearised"), 2.4, false, libdcp::colour_matrix::srgb_to_xyz, 2.6));
84 _colour_conversions.push_back (PresetColourConversion (_("Rec. 709"), 2.2, false, libdcp::colour_matrix::rec709_to_xyz, 2.6));
92 if (!boost::filesystem::exists (file (false))) {
97 cxml::Document f ("Config");
98 f.read_file (file (false));
101 optional<int> version = f.optional_number_child<int> ("Version");
103 _num_local_encoding_threads = f.number_child<int> ("NumLocalEncodingThreads");
104 _default_directory = f.string_child ("DefaultDirectory");
106 boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
108 b = f.optional_number_child<int> ("ServerPortBase");
110 _server_port_base = b.get ();
112 boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
113 _use_any_servers = u.get_value_or (true);
115 list<cxml::NodePtr> servers = f.node_children ("Server");
116 for (list<cxml::NodePtr>::iterator i = servers.begin(); i != servers.end(); ++i) {
117 if ((*i)->node_children("HostName").size() == 1) {
118 _servers.push_back ((*i)->string_child ("HostName"));
120 _servers.push_back ((*i)->content ());
124 _tms_ip = f.string_child ("TMSIP");
125 _tms_path = f.string_child ("TMSPath");
126 _tms_user = f.string_child ("TMSUser");
127 _tms_password = f.string_child ("TMSPassword");
129 c = f.optional_string_child ("SoundProcessor");
131 _sound_processor = SoundProcessor::from_id (c.get ());
134 _language = f.optional_string_child ("Language");
136 c = f.optional_string_child ("DefaultContainer");
138 _default_container = Ratio::from_id (c.get ());
141 c = f.optional_string_child ("DefaultDCPContentType");
143 _default_dcp_content_type = DCPContentType::from_dci_name (c.get ());
146 _dcp_metadata.issuer = f.optional_string_child ("DCPMetadataIssuer").get_value_or ("");
147 _dcp_metadata.creator = f.optional_string_child ("DCPMetadataCreator").get_value_or ("");
149 _default_dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
150 _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
151 _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
152 _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
154 list<cxml::NodePtr> cc = f.node_children ("ColourConversion");
157 _colour_conversions.clear ();
160 for (list<cxml::NodePtr>::iterator i = cc.begin(); i != cc.end(); ++i) {
161 _colour_conversions.push_back (PresetColourConversion (*i));
165 /* Loading version 0 (before Rec. 709 was added as a preset).
168 _colour_conversions.push_back (PresetColourConversion (_("Rec. 709"), 2.2, false, libdcp::colour_matrix::rec709_to_xyz, 2.6));
171 list<cxml::NodePtr> cin = f.node_children ("Cinema");
172 for (list<cxml::NodePtr>::iterator i = cin.begin(); i != cin.end(); ++i) {
173 /* Slightly grotty two-part construction of Cinema here so that we can use
176 shared_ptr<Cinema> cinema (new Cinema (*i));
177 cinema->read_screens (*i);
178 _cinemas.push_back (cinema);
181 _mail_server = f.string_child ("MailServer");
182 _mail_user = f.optional_string_child("MailUser").get_value_or ("");
183 _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
184 _kdm_from = f.string_child ("KDMFrom");
185 _kdm_email = f.string_child ("KDMEmail");
187 _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
188 _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
190 _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
194 Config::read_old_metadata ()
196 /* XXX: this won't work with non-Latin filenames */
197 ifstream f (file(true).string().c_str ());
200 while (getline (f, line)) {
205 if (line[0] == '#') {
209 size_t const s = line.find (' ');
210 if (s == string::npos) {
214 string const k = line.substr (0, s);
215 string const v = line.substr (s + 1);
217 if (k == N_("num_local_encoding_threads")) {
218 _num_local_encoding_threads = atoi (v.c_str ());
219 } else if (k == N_("default_directory")) {
220 _default_directory = v;
221 } else if (k == N_("server_port")) {
222 _server_port_base = atoi (v.c_str ());
223 } else if (k == N_("server")) {
225 split (b, v, is_any_of (" "));
227 _servers.push_back (b[0]);
229 } else if (k == N_("tms_ip")) {
231 } else if (k == N_("tms_path")) {
233 } else if (k == N_("tms_user")) {
235 } else if (k == N_("tms_password")) {
237 } else if (k == N_("sound_processor")) {
238 _sound_processor = SoundProcessor::from_id (v);
239 } else if (k == "language") {
241 } else if (k == "default_container") {
242 _default_container = Ratio::from_id (v);
243 } else if (k == "default_dcp_content_type") {
244 _default_dcp_content_type = DCPContentType::from_dci_name (v);
245 } else if (k == "dcp_metadata_issuer") {
246 _dcp_metadata.issuer = v;
247 } else if (k == "dcp_metadata_creator") {
248 _dcp_metadata.creator = v;
249 } else if (k == "dcp_metadata_issue_date") {
250 _dcp_metadata.issue_date = v;
253 _default_dci_metadata.read_old_metadata (k, v);
257 /** @return Filename to write configuration to */
258 boost::filesystem::path
259 Config::file (bool old) const
261 boost::filesystem::path p;
262 p /= g_get_user_config_dir ();
263 boost::system::error_code ec;
264 boost::filesystem::create_directory (p, ec);
269 boost::filesystem::create_directory (p, ec);
275 boost::filesystem::path
276 Config::signer_chain_directory () const
278 boost::filesystem::path p;
279 p /= g_get_user_config_dir ();
282 boost::filesystem::create_directories (p);
286 /** @return Singleton instance */
290 if (_instance == 0) {
291 _instance = new Config;
294 } catch (exception& e) {
295 /* configuration load failed; never mind, just
296 stick with the default.
298 cerr << "dcpomatic: failed to load configuration (" << e.what() << ")\n";
300 cerr << "dcpomatic: failed to load configuration\n";
307 /** Write our configuration to disk */
309 Config::write () const
314 xmlpp::Element* root = doc.create_root_node ("Config");
316 root->add_child("Version")->add_child_text ("1");
317 root->add_child("NumLocalEncodingThreads")->add_child_text (lexical_cast<string> (_num_local_encoding_threads));
318 root->add_child("DefaultDirectory")->add_child_text (_default_directory.string ());
319 root->add_child("ServerPortBase")->add_child_text (lexical_cast<string> (_server_port_base));
320 root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
322 for (vector<string>::const_iterator i = _servers.begin(); i != _servers.end(); ++i) {
323 root->add_child("Server")->add_child_text (*i);
326 root->add_child("TMSIP")->add_child_text (_tms_ip);
327 root->add_child("TMSPath")->add_child_text (_tms_path);
328 root->add_child("TMSUser")->add_child_text (_tms_user);
329 root->add_child("TMSPassword")->add_child_text (_tms_password);
330 if (_sound_processor) {
331 root->add_child("SoundProcessor")->add_child_text (_sound_processor->id ());
334 root->add_child("Language")->add_child_text (_language.get());
336 if (_default_container) {
337 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
339 if (_default_dcp_content_type) {
340 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->dci_name ());
342 root->add_child("DCPMetadataIssuer")->add_child_text (_dcp_metadata.issuer);
343 root->add_child("DCPMetadataCreator")->add_child_text (_dcp_metadata.creator);
345 _default_dci_metadata.as_xml (root->add_child ("DCIMetadata"));
347 root->add_child("DefaultStillLength")->add_child_text (lexical_cast<string> (_default_still_length));
348 root->add_child("DefaultJ2KBandwidth")->add_child_text (lexical_cast<string> (_default_j2k_bandwidth));
349 root->add_child("DefaultAudioDelay")->add_child_text (lexical_cast<string> (_default_audio_delay));
351 for (vector<PresetColourConversion>::const_iterator i = _colour_conversions.begin(); i != _colour_conversions.end(); ++i) {
352 i->as_xml (root->add_child ("ColourConversion"));
355 for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
356 (*i)->as_xml (root->add_child ("Cinema"));
359 root->add_child("MailServer")->add_child_text (_mail_server);
360 root->add_child("MailUser")->add_child_text (_mail_user);
361 root->add_child("MailPassword")->add_child_text (_mail_password);
362 root->add_child("KDMFrom")->add_child_text (_kdm_from);
363 root->add_child("KDMEmail")->add_child_text (_kdm_email);
365 root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
366 root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
368 root->add_child("MaximumJ2KBandwidth")->add_child_text (lexical_cast<string> (_maximum_j2k_bandwidth));
370 doc.write_to_file_formatted (file(false).string ());
373 boost::filesystem::path
374 Config::default_directory_or (boost::filesystem::path a) const
376 if (_default_directory.empty()) {
380 boost::system::error_code ec;
381 bool const e = boost::filesystem::exists (_default_directory, ec);
386 return _default_directory;