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 <libdcp/raw_convert.h>
28 #include <libcxml/cxml.h>
34 #include "dcp_content_type.h"
35 #include "sound_processor.h"
36 #include "colour_conversion.h"
49 using boost::shared_ptr;
50 using boost::optional;
51 using boost::algorithm::is_any_of;
52 using boost::algorithm::split;
53 using libdcp::raw_convert;
55 Config* Config::_instance = 0;
57 /** Construct default configuration */
59 : _num_local_encoding_threads (max (2U, boost::thread::hardware_concurrency()))
60 , _server_port_base (6192)
61 , _use_any_servers (true)
63 , _sound_processor (SoundProcessor::from_id (N_("dolby_cp750")))
64 , _allow_any_dcp_frame_rate (false)
65 , _default_still_length (10)
66 , _default_scale (Ratio::from_id ("185"))
67 , _default_container (Ratio::from_id ("185"))
68 , _default_dcp_content_type (DCPContentType::from_isdcf_name ("TST"))
69 , _default_j2k_bandwidth (100000000)
70 , _default_audio_delay (0)
71 , _check_for_updates (false)
72 , _check_for_test_updates (false)
73 , _maximum_j2k_bandwidth (250000000)
74 , _log_types (Log::TYPE_GENERAL | Log::TYPE_WARNING | Log::TYPE_ERROR)
76 _allowed_dcp_frame_rates.push_back (24);
77 _allowed_dcp_frame_rates.push_back (25);
78 _allowed_dcp_frame_rates.push_back (30);
79 _allowed_dcp_frame_rates.push_back (48);
80 _allowed_dcp_frame_rates.push_back (50);
81 _allowed_dcp_frame_rates.push_back (60);
83 _colour_conversions.push_back (PresetColourConversion (_("sRGB"), 2.4, true, libdcp::colour_matrix::srgb_to_xyz, 2.6));
84 _colour_conversions.push_back (PresetColourConversion (_("sRGB non-linearised"), 2.4, false, libdcp::colour_matrix::srgb_to_xyz, 2.6));
85 _colour_conversions.push_back (PresetColourConversion (_("Rec. 709"), 2.2, false, libdcp::colour_matrix::rec709_to_xyz, 2.6));
93 if (!boost::filesystem::exists (file (false))) {
98 cxml::Document f ("Config");
99 f.read_file (file (false));
102 optional<int> version = f.optional_number_child<int> ("Version");
104 _num_local_encoding_threads = f.number_child<int> ("NumLocalEncodingThreads");
105 _default_directory = f.string_child ("DefaultDirectory");
107 boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
109 b = f.optional_number_child<int> ("ServerPortBase");
111 _server_port_base = b.get ();
113 boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
114 _use_any_servers = u.get_value_or (true);
116 list<cxml::NodePtr> servers = f.node_children ("Server");
117 for (list<cxml::NodePtr>::iterator i = servers.begin(); i != servers.end(); ++i) {
118 if ((*i)->node_children("HostName").size() == 1) {
119 _servers.push_back ((*i)->string_child ("HostName"));
121 _servers.push_back ((*i)->content ());
125 _tms_ip = f.string_child ("TMSIP");
126 _tms_path = f.string_child ("TMSPath");
127 _tms_user = f.string_child ("TMSUser");
128 _tms_password = f.string_child ("TMSPassword");
130 c = f.optional_string_child ("SoundProcessor");
132 _sound_processor = SoundProcessor::from_id (c.get ());
135 _language = f.optional_string_child ("Language");
137 c = f.optional_string_child ("DefaultScale");
139 _default_scale = Ratio::from_id (c.get ());
142 c = f.optional_string_child ("DefaultContainer");
144 _default_container = Ratio::from_id (c.get ());
147 c = f.optional_string_child ("DefaultDCPContentType");
149 _default_dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
152 _dcp_metadata.issuer = f.optional_string_child ("DCPMetadataIssuer").get_value_or ("");
153 _dcp_metadata.creator = f.optional_string_child ("DCPMetadataCreator").get_value_or ("");
155 if (version && version.get() >= 2) {
156 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
158 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
161 _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
162 _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
163 _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
165 list<cxml::NodePtr> cc = f.node_children ("ColourConversion");
168 _colour_conversions.clear ();
171 for (list<cxml::NodePtr>::iterator i = cc.begin(); i != cc.end(); ++i) {
172 _colour_conversions.push_back (PresetColourConversion (*i));
176 /* Loading version 0 (before Rec. 709 was added as a preset).
179 _colour_conversions.push_back (PresetColourConversion (_("Rec. 709"), 2.2, false, libdcp::colour_matrix::rec709_to_xyz, 2.6));
182 list<cxml::NodePtr> cin = f.node_children ("Cinema");
183 for (list<cxml::NodePtr>::iterator i = cin.begin(); i != cin.end(); ++i) {
184 /* Slightly grotty two-part construction of Cinema here so that we can use
187 shared_ptr<Cinema> cinema (new Cinema (*i));
188 cinema->read_screens (*i);
189 _cinemas.push_back (cinema);
192 _mail_server = f.string_child ("MailServer");
193 _mail_user = f.optional_string_child("MailUser").get_value_or ("");
194 _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
195 _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
196 _kdm_from = f.string_child ("KDMFrom");
197 _kdm_cc = f.optional_string_child ("KDMCC").get_value_or ("");
198 _kdm_email = f.string_child ("KDMEmail");
200 _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
201 _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
203 _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
204 _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate");
206 _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (Log::TYPE_GENERAL | Log::TYPE_WARNING | Log::TYPE_ERROR);
210 Config::read_old_metadata ()
212 /* XXX: this won't work with non-Latin filenames */
213 ifstream f (file(true).string().c_str ());
216 while (getline (f, line)) {
221 if (line[0] == '#') {
225 size_t const s = line.find (' ');
226 if (s == string::npos) {
230 string const k = line.substr (0, s);
231 string const v = line.substr (s + 1);
233 if (k == N_("num_local_encoding_threads")) {
234 _num_local_encoding_threads = atoi (v.c_str ());
235 } else if (k == N_("default_directory")) {
236 _default_directory = v;
237 } else if (k == N_("server_port")) {
238 _server_port_base = atoi (v.c_str ());
239 } else if (k == N_("server")) {
241 split (b, v, is_any_of (" "));
243 _servers.push_back (b[0]);
245 } else if (k == N_("tms_ip")) {
247 } else if (k == N_("tms_path")) {
249 } else if (k == N_("tms_user")) {
251 } else if (k == N_("tms_password")) {
253 } else if (k == N_("sound_processor")) {
254 _sound_processor = SoundProcessor::from_id (v);
255 } else if (k == "language") {
257 } else if (k == "default_container") {
258 _default_container = Ratio::from_id (v);
259 } else if (k == "default_dcp_content_type") {
260 _default_dcp_content_type = DCPContentType::from_isdcf_name (v);
261 } else if (k == "dcp_metadata_issuer") {
262 _dcp_metadata.issuer = v;
263 } else if (k == "dcp_metadata_creator") {
264 _dcp_metadata.creator = v;
265 } else if (k == "dcp_metadata_issue_date") {
266 _dcp_metadata.issue_date = v;
269 _default_isdcf_metadata.read_old_metadata (k, v);
273 /** @return Filename to write configuration to */
274 boost::filesystem::path
275 Config::file (bool old) const
277 boost::filesystem::path p;
278 p /= g_get_user_config_dir ();
279 boost::system::error_code ec;
280 boost::filesystem::create_directory (p, ec);
285 boost::filesystem::create_directory (p, ec);
291 boost::filesystem::path
292 Config::signer_chain_directory () const
294 boost::filesystem::path p;
295 p /= g_get_user_config_dir ();
298 boost::filesystem::create_directories (p);
302 /** @return Singleton instance */
306 if (_instance == 0) {
307 _instance = new Config;
310 } catch (exception& e) {
311 /* configuration load failed; never mind, just
312 stick with the default.
314 cerr << "dcpomatic: failed to load configuration (" << e.what() << ")\n";
316 cerr << "dcpomatic: failed to load configuration\n";
323 /** Write our configuration to disk */
325 Config::write () const
328 xmlpp::Element* root = doc.create_root_node ("Config");
330 root->add_child("Version")->add_child_text ("2");
331 root->add_child("NumLocalEncodingThreads")->add_child_text (raw_convert<string> (_num_local_encoding_threads));
332 root->add_child("DefaultDirectory")->add_child_text (_default_directory.string ());
333 root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
334 root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
336 for (vector<string>::const_iterator i = _servers.begin(); i != _servers.end(); ++i) {
337 root->add_child("Server")->add_child_text (*i);
340 root->add_child("TMSIP")->add_child_text (_tms_ip);
341 root->add_child("TMSPath")->add_child_text (_tms_path);
342 root->add_child("TMSUser")->add_child_text (_tms_user);
343 root->add_child("TMSPassword")->add_child_text (_tms_password);
344 if (_sound_processor) {
345 root->add_child("SoundProcessor")->add_child_text (_sound_processor->id ());
348 root->add_child("Language")->add_child_text (_language.get());
350 if (_default_scale) {
351 root->add_child("DefaultScale")->add_child_text (_default_scale->id ());
353 if (_default_container) {
354 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
356 if (_default_dcp_content_type) {
357 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
359 root->add_child("DCPMetadataIssuer")->add_child_text (_dcp_metadata.issuer);
360 root->add_child("DCPMetadataCreator")->add_child_text (_dcp_metadata.creator);
362 _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
364 root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
365 root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
366 root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
368 for (vector<PresetColourConversion>::const_iterator i = _colour_conversions.begin(); i != _colour_conversions.end(); ++i) {
369 i->as_xml (root->add_child ("ColourConversion"));
372 for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
373 (*i)->as_xml (root->add_child ("Cinema"));
376 root->add_child("MailServer")->add_child_text (_mail_server);
377 root->add_child("MailUser")->add_child_text (_mail_user);
378 root->add_child("MailPassword")->add_child_text (_mail_password);
379 root->add_child("KDMSubject")->add_child_text (_kdm_subject);
380 root->add_child("KDMFrom")->add_child_text (_kdm_from);
381 root->add_child("KDMCC")->add_child_text (_kdm_cc);
382 root->add_child("KDMEmail")->add_child_text (_kdm_email);
384 root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
385 root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
387 root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
388 root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
389 root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
391 doc.write_to_file_formatted (file(false).string ());
394 boost::filesystem::path
395 Config::default_directory_or (boost::filesystem::path a) const
397 if (_default_directory.empty()) {
401 boost::system::error_code ec;
402 bool const e = boost::filesystem::exists (_default_directory, ec);
407 return _default_directory;
425 Config::reset_kdm_email ()
428 "Dear Projectionist\n\n"
429 "Please find attached KDMs for $CPL_NAME.\n\n"
430 "Cinema: $CINEMA_NAME\n"
431 "Screen(s): $SCREENS\n\n"
432 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
433 "Best regards,\nDCP-o-matic"