src/lib/config.cc

   1 /*
   2     Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 #include <sstream>
  21 #include <cstdlib>
  22 #include <fstream>
  23 #include <glib.h>
  24 #include <boost/filesystem.hpp>
  25 #include <boost/algorithm/string.hpp>
  26 #include <dcp/colour_matrix.h>
  27 #include <dcp/raw_convert.h>
  28 #include <libcxml/cxml.h>
  29 #include "config.h"
  30 #include "server.h"
  31 #include "scaler.h"
  32 #include "filter.h"
  33 #include "ratio.h"
  34 #include "dcp_content_type.h"
  35 #include "cinema_sound_processor.h"
  36 #include "colour_conversion.h"
  37 #include "cinema.h"
  38 #include "util.h"
  39
  40 #include "i18n.h"
  41
  42 using std::vector;
  43 using std::ifstream;
  44 using std::string;
  45 using std::list;
  46 using std::max;
  47 using std::exception;
  48 using std::cerr;
  49 using boost::shared_ptr;
  50 using boost::optional;
  51 using boost::algorithm::is_any_of;
  52 using boost::algorithm::split;
  53 using dcp::raw_convert;
  54
  55 Config* Config::_instance = 0;
  56
  57 /** Construct default configuration */
  58 Config::Config ()
  59         : _num_local_encoding_threads (max (2U, boost::thread::hardware_concurrency()))
  60         , _server_port_base (6192)
  61         , _use_any_servers (true)
  62         , _tms_path (".")
  63         , _cinema_sound_processor (CinemaSoundProcessor::from_id (N_("dolby_cp750")))
  64         , _allow_any_dcp_frame_rate (false)
  65         , _default_still_length (10)
  66         , _default_container (Ratio::from_id ("185"))
  67         , _default_dcp_content_type (DCPContentType::from_isdcf_name ("TST"))
  68         , _default_j2k_bandwidth (100000000)
  69         , _default_audio_delay (0)
  70         , _check_for_updates (false)
  71         , _check_for_test_updates (false)
  72         , _maximum_j2k_bandwidth (250000000)
  73         , _log_types (Log::TYPE_GENERAL | Log::TYPE_WARNING | Log::TYPE_ERROR)
  74 {
  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);
  81
  82         _colour_conversions.push_back (PresetColourConversion (_("sRGB"), 2.4, true, dcp::colour_matrix::srgb_to_xyz, 2.6));
  83         _colour_conversions.push_back (PresetColourConversion (_("sRGB non-linearised"), 2.4, false, dcp::colour_matrix::srgb_to_xyz, 2.6));
  84         _colour_conversions.push_back (PresetColourConversion (_("Rec. 709"), 2.2, false, dcp::colour_matrix::rec709_to_xyz, 2.6));
  85
  86         reset_kdm_email ();
  87 }
  88
  89 void
  90 Config::read ()
  91 {
  92         if (!boost::filesystem::exists (file (false))) {
  93                 read_old_metadata ();
  94                 return;
  95         }
  96
  97         cxml::Document f ("Config");
  98         f.read_file (file (false));
  99         optional<string> c;
 100
 101         optional<int> version = f.optional_number_child<int> ("Version");
 102
 103         _num_local_encoding_threads = f.number_child<int> ("NumLocalEncodingThreads");
 104         _default_directory = f.string_child ("DefaultDirectory");
 105
 106         boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
 107         if (!b) {
 108                 b = f.optional_number_child<int> ("ServerPortBase");
 109         }
 110         _server_port_base = b.get ();
 111
 112         boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
 113         _use_any_servers = u.get_value_or (true);
 114
 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"));
 119                 } else {
 120                         _servers.push_back ((*i)->content ());
 121                 }
 122         }
 123
 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");
 128
 129         c = f.optional_string_child ("SoundProcessor");
 130         if (c) {
 131                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
 132         }
 133         c = f.optional_string_child ("CinemaSoundProcessor");
 134         if (c) {
 135                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
 136         }
 137
 138         _language = f.optional_string_child ("Language");
 139
 140         c = f.optional_string_child ("DefaultContainer");
 141         if (c) {
 142                 _default_container = Ratio::from_id (c.get ());
 143         }
 144
 145         c = f.optional_string_child ("DefaultDCPContentType");
 146         if (c) {
 147                 _default_dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
 148         }
 149
 150         _dcp_metadata.issuer = f.optional_string_child ("DCPMetadataIssuer").get_value_or ("");
 151         _dcp_metadata.creator = f.optional_string_child ("DCPMetadataCreator").get_value_or ("");
 152
 153         if (version && version.get() >= 2) {
 154                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
 155         } else {
 156                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
 157         }
 158
 159         _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
 160         _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
 161         _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
 162
 163         list<cxml::NodePtr> cc = f.node_children ("ColourConversion");
 164
 165         if (!cc.empty ()) {
 166                 _colour_conversions.clear ();
 167         }
 168
 169         for (list<cxml::NodePtr>::iterator i = cc.begin(); i != cc.end(); ++i) {
 170                 _colour_conversions.push_back (PresetColourConversion (*i));
 171         }
 172
 173         if (!version) {
 174                 /* Loading version 0 (before Rec. 709 was added as a preset).
 175                    Add it in.
 176                 */
 177                 _colour_conversions.push_back (PresetColourConversion (_("Rec. 709"), 2.2, false, dcp::colour_matrix::rec709_to_xyz, 2.6));
 178         }
 179
 180         list<cxml::NodePtr> cin = f.node_children ("Cinema");
 181         for (list<cxml::NodePtr>::iterator i = cin.begin(); i != cin.end(); ++i) {
 182                 /* Slightly grotty two-part construction of Cinema here so that we can use
 183                    shared_from_this.
 184                 */
 185                 shared_ptr<Cinema> cinema (new Cinema (*i));
 186                 cinema->read_screens (*i);
 187                 _cinemas.push_back (cinema);
 188         }
 189
 190         _mail_server = f.string_child ("MailServer");
 191         _mail_user = f.optional_string_child("MailUser").get_value_or ("");
 192         _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
 193         _kdm_from = f.string_child ("KDMFrom");
 194         _kdm_cc = f.optional_string_child ("KDMCC").get_value_or ("");
 195         _kdm_email = f.string_child ("KDMEmail");
 196
 197         _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
 198         _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
 199
 200         _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
 201         _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate");
 202
 203         _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (Log::TYPE_GENERAL | Log::TYPE_WARNING | Log::TYPE_ERROR);
 204 }
 205
 206 void
 207 Config::read_old_metadata ()
 208 {
 209         /* XXX: this won't work with non-Latin filenames */
 210         ifstream f (file(true).string().c_str ());
 211         string line;
 212
 213         while (getline (f, line)) {
 214                 if (line.empty ()) {
 215                         continue;
 216                 }
 217
 218                 if (line[0] == '#') {
 219                         continue;
 220                 }
 221
 222                 size_t const s = line.find (' ');
 223                 if (s == string::npos) {
 224                         continue;
 225                 }
 226
 227                 string const k = line.substr (0, s);
 228                 string const v = line.substr (s + 1);
 229
 230                 if (k == N_("num_local_encoding_threads")) {
 231                         _num_local_encoding_threads = atoi (v.c_str ());
 232                 } else if (k == N_("default_directory")) {
 233                         _default_directory = v;
 234                 } else if (k == N_("server_port")) {
 235                         _server_port_base = atoi (v.c_str ());
 236                 } else if (k == N_("server")) {
 237                         vector<string> b;
 238                         split (b, v, is_any_of (" "));
 239                         if (b.size() == 2) {
 240                                 _servers.push_back (b[0]);
 241                         }
 242                 } else if (k == N_("tms_ip")) {
 243                         _tms_ip = v;
 244                 } else if (k == N_("tms_path")) {
 245                         _tms_path = v;
 246                 } else if (k == N_("tms_user")) {
 247                         _tms_user = v;
 248                 } else if (k == N_("tms_password")) {
 249                         _tms_password = v;
 250                 } else if (k == N_("sound_processor")) {
 251                         _cinema_sound_processor = CinemaSoundProcessor::from_id (v);
 252                 } else if (k == "language") {
 253                         _language = v;
 254                 } else if (k == "default_container") {
 255                         _default_container = Ratio::from_id (v);
 256                 } else if (k == "default_dcp_content_type") {
 257                         _default_dcp_content_type = DCPContentType::from_isdcf_name (v);
 258                 } else if (k == "dcp_metadata_issuer") {
 259                         _dcp_metadata.issuer = v;
 260                 } else if (k == "dcp_metadata_creator") {
 261                         _dcp_metadata.creator = v;
 262                 } else if (k == "dcp_metadata_issue_date") {
 263                         _dcp_metadata.issue_date = v;
 264                 }
 265
 266                 _default_isdcf_metadata.read_old_metadata (k, v);
 267         }
 268 }
 269
 270 /** @return Filename to write configuration to */
 271 boost::filesystem::path
 272 Config::file (bool old) const
 273 {
 274         boost::filesystem::path p;
 275         p /= g_get_user_config_dir ();
 276         boost::system::error_code ec;
 277         boost::filesystem::create_directory (p, ec);
 278         if (old) {
 279                 p /= ".dvdomatic";
 280         } else {
 281                 p /= "dcpomatic";
 282                 boost::filesystem::create_directory (p, ec);
 283                 p /= "config.xml";
 284         }
 285         return p;
 286 }
 287
 288 boost::filesystem::path
 289 Config::signer_chain_directory () const
 290 {
 291         boost::filesystem::path p;
 292         p /= g_get_user_config_dir ();
 293         p /= "dcpomatic";
 294         p /= "crypt";
 295         boost::filesystem::create_directories (p);
 296         return p;
 297 }
 298
 299 /** @return Singleton instance */
 300 Config *
 301 Config::instance ()
 302 {
 303         if (_instance == 0) {
 304                 _instance = new Config;
 305                 try {
 306                         _instance->read ();
 307                 } catch (exception& e) {
 308                         /* configuration load failed; never mind, just
 309                            stick with the default.
 310                         */
 311                         cerr << "dcpomatic: failed to load configuration (" << e.what() << ")\n";
 312                 } catch (...) {
 313                         cerr << "dcpomatic: failed to load configuration\n";
 314                 }
 315         }
 316
 317         return _instance;
 318 }
 319
 320 /** Write our configuration to disk */
 321 void
 322 Config::write () const
 323 {
 324         xmlpp::Document doc;
 325         xmlpp::Element* root = doc.create_root_node ("Config");
 326
 327         root->add_child("Version")->add_child_text ("2");
 328         root->add_child("NumLocalEncodingThreads")->add_child_text (raw_convert<string> (_num_local_encoding_threads));
 329         root->add_child("DefaultDirectory")->add_child_text (_default_directory.string ());
 330         root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
 331         root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
 332
 333         for (vector<string>::const_iterator i = _servers.begin(); i != _servers.end(); ++i) {
 334                 root->add_child("Server")->add_child_text (*i);
 335         }
 336
 337         root->add_child("TMSIP")->add_child_text (_tms_ip);
 338         root->add_child("TMSPath")->add_child_text (_tms_path);
 339         root->add_child("TMSUser")->add_child_text (_tms_user);
 340         root->add_child("TMSPassword")->add_child_text (_tms_password);
 341         if (_cinema_sound_processor) {
 342                 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
 343         }
 344         if (_language) {
 345                 root->add_child("Language")->add_child_text (_language.get());
 346         }
 347         if (_default_container) {
 348                 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
 349         }
 350         if (_default_dcp_content_type) {
 351                 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
 352         }
 353         root->add_child("DCPMetadataIssuer")->add_child_text (_dcp_metadata.issuer);
 354         root->add_child("DCPMetadataCreator")->add_child_text (_dcp_metadata.creator);
 355
 356         _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
 357
 358         root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
 359         root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
 360         root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
 361
 362         for (vector<PresetColourConversion>::const_iterator i = _colour_conversions.begin(); i != _colour_conversions.end(); ++i) {
 363                 i->as_xml (root->add_child ("ColourConversion"));
 364         }
 365
 366         for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
 367                 (*i)->as_xml (root->add_child ("Cinema"));
 368         }
 369
 370         root->add_child("MailServer")->add_child_text (_mail_server);
 371         root->add_child("MailUser")->add_child_text (_mail_user);
 372         root->add_child("MailPassword")->add_child_text (_mail_password);
 373         root->add_child("KDMFrom")->add_child_text (_kdm_from);
 374         root->add_child("KDMCC")->add_child_text (_kdm_cc);
 375         root->add_child("KDMEmail")->add_child_text (_kdm_email);
 376
 377         root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
 378         root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
 379
 380         root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
 381         root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
 382         root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
 383
 384         doc.write_to_file_formatted (file(false).string ());
 385 }
 386
 387 boost::filesystem::path
 388 Config::default_directory_or (boost::filesystem::path a) const
 389 {
 390         if (_default_directory.empty()) {
 391                 return a;
 392         }
 393
 394         boost::system::error_code ec;
 395         bool const e = boost::filesystem::exists (_default_directory, ec);
 396         if (ec || !e) {
 397                 return a;
 398         }
 399
 400         return _default_directory;
 401 }
 402
 403 void
 404 Config::drop ()
 405 {
 406         delete _instance;
 407         _instance = 0;
 408 }
 409
 410 void
 411 Config::changed ()
 412 {
 413         write ();
 414         Changed ();
 415 }
 416
 417 void
 418 Config::reset_kdm_email ()
 419 {
 420         _kdm_email = _(
 421                 "Dear Projectionist\n\n"
 422                 "Please find attached KDMs for $CPL_NAME.\n\n"
 423                 "Cinema: $CINEMA_NAME\n"
 424                 "Screen(s): $SCREENS\n\n"
 425                 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
 426                 "Best regards,\nDCP-o-matic"
 427                 );
 428 }