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 <libdcp/colour_matrix.h>
  27 #include <libcxml/cxml.h>
  28 #include "config.h"
  29 #include "server.h"
  30 #include "scaler.h"
  31 #include "filter.h"
  32 #include "ratio.h"
  33 #include "dcp_content_type.h"
  34 #include "sound_processor.h"
  35 #include "colour_conversion.h"
  36 #include "cinema.h"
  37 #include "util.h"
  38
  39 #include "i18n.h"
  40
  41 using std::vector;
  42 using std::ifstream;
  43 using std::string;
  44 using std::list;
  45 using std::max;
  46 using std::exception;
  47 using std::cerr;
  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;
  53
  54 Config* Config::_instance = 0;
  55
  56 /** Construct default configuration */
  57 Config::Config ()
  58         : _num_local_encoding_threads (max (2U, boost::thread::hardware_concurrency()))
  59         , _server_port_base (6192)
  60         , _use_any_servers (true)
  61         , _tms_path (".")
  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)
  68         , _kdm_email (
  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")
  70                 )
  71         , _check_for_updates (false)
  72         , _check_for_test_updates (false)
  73         , _maximum_j2k_bandwidth (250000000)
  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, 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));
  85 }
  86
  87 void
  88 Config::read ()
  89 {
  90         LocaleGuard lg;
  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                 _sound_processor = SoundProcessor::from_id (c.get ());
 132         }
 133
 134         _language = f.optional_string_child ("Language");
 135
 136         c = f.optional_string_child ("DefaultContainer");
 137         if (c) {
 138                 _default_container = Ratio::from_id (c.get ());
 139         }
 140
 141         c = f.optional_string_child ("DefaultDCPContentType");
 142         if (c) {
 143                 _default_dcp_content_type = DCPContentType::from_dci_name (c.get ());
 144         }
 145
 146         _dcp_metadata.issuer = f.optional_string_child ("DCPMetadataIssuer").get_value_or ("");
 147         _dcp_metadata.creator = f.optional_string_child ("DCPMetadataCreator").get_value_or ("");
 148
 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);
 153
 154         list<cxml::NodePtr> cc = f.node_children ("ColourConversion");
 155
 156         if (!cc.empty ()) {
 157                 _colour_conversions.clear ();
 158         }
 159
 160         for (list<cxml::NodePtr>::iterator i = cc.begin(); i != cc.end(); ++i) {
 161                 _colour_conversions.push_back (PresetColourConversion (*i));
 162         }
 163
 164         if (!version) {
 165                 /* Loading version 0 (before Rec. 709 was added as a preset).
 166                    Add it in.
 167                 */
 168                 _colour_conversions.push_back (PresetColourConversion (_("Rec. 709"), 2.2, false, libdcp::colour_matrix::rec709_to_xyz, 2.6));
 169         }
 170
 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
 174                    shared_from_this.
 175                 */
 176                 shared_ptr<Cinema> cinema (new Cinema (*i));
 177                 cinema->read_screens (*i);
 178                 _cinemas.push_back (cinema);
 179         }
 180
 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");
 186
 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);
 189
 190         _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
 191 }
 192
 193 void
 194 Config::read_old_metadata ()
 195 {
 196         /* XXX: this won't work with non-Latin filenames */
 197         ifstream f (file(true).string().c_str ());
 198         string line;
 199
 200         while (getline (f, line)) {
 201                 if (line.empty ()) {
 202                         continue;
 203                 }
 204
 205                 if (line[0] == '#') {
 206                         continue;
 207                 }
 208
 209                 size_t const s = line.find (' ');
 210                 if (s == string::npos) {
 211                         continue;
 212                 }
 213
 214                 string const k = line.substr (0, s);
 215                 string const v = line.substr (s + 1);
 216
 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")) {
 224                         vector<string> b;
 225                         split (b, v, is_any_of (" "));
 226                         if (b.size() == 2) {
 227                                 _servers.push_back (b[0]);
 228                         }
 229                 } else if (k == N_("tms_ip")) {
 230                         _tms_ip = v;
 231                 } else if (k == N_("tms_path")) {
 232                         _tms_path = v;
 233                 } else if (k == N_("tms_user")) {
 234                         _tms_user = v;
 235                 } else if (k == N_("tms_password")) {
 236                         _tms_password = v;
 237                 } else if (k == N_("sound_processor")) {
 238                         _sound_processor = SoundProcessor::from_id (v);
 239                 } else if (k == "language") {
 240                         _language = v;
 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;
 251                 }
 252
 253                 _default_dci_metadata.read_old_metadata (k, v);
 254         }
 255 }
 256
 257 /** @return Filename to write configuration to */
 258 boost::filesystem::path
 259 Config::file (bool old) const
 260 {
 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);
 265         if (old) {
 266                 p /= ".dvdomatic";
 267         } else {
 268                 p /= "dcpomatic";
 269                 boost::filesystem::create_directory (p, ec);
 270                 p /= "config.xml";
 271         }
 272         return p;
 273 }
 274
 275 boost::filesystem::path
 276 Config::signer_chain_directory () const
 277 {
 278         boost::filesystem::path p;
 279         p /= g_get_user_config_dir ();
 280         p /= "dcpomatic";
 281         p /= "crypt";
 282         boost::filesystem::create_directories (p);
 283         return p;
 284 }
 285
 286 /** @return Singleton instance */
 287 Config *
 288 Config::instance ()
 289 {
 290         if (_instance == 0) {
 291                 _instance = new Config;
 292                 try {
 293                         _instance->read ();
 294                 } catch (exception& e) {
 295                         /* configuration load failed; never mind, just
 296                            stick with the default.
 297                         */
 298                         cerr << "dcpomatic: failed to load configuration (" << e.what() << ")\n";
 299                 } catch (...) {
 300                         cerr << "dcpomatic: failed to load configuration\n";
 301                 }
 302         }
 303
 304         return _instance;
 305 }
 306
 307 /** Write our configuration to disk */
 308 void
 309 Config::write () const
 310 {
 311         LocaleGuard lg;
 312
 313         xmlpp::Document doc;
 314         xmlpp::Element* root = doc.create_root_node ("Config");
 315
 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");
 321
 322         for (vector<string>::const_iterator i = _servers.begin(); i != _servers.end(); ++i) {
 323                 root->add_child("Server")->add_child_text (*i);
 324         }
 325
 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 ());
 332         }
 333         if (_language) {
 334                 root->add_child("Language")->add_child_text (_language.get());
 335         }
 336         if (_default_container) {
 337                 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
 338         }
 339         if (_default_dcp_content_type) {
 340                 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->dci_name ());
 341         }
 342         root->add_child("DCPMetadataIssuer")->add_child_text (_dcp_metadata.issuer);
 343         root->add_child("DCPMetadataCreator")->add_child_text (_dcp_metadata.creator);
 344
 345         _default_dci_metadata.as_xml (root->add_child ("DCIMetadata"));
 346
 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));
 350
 351         for (vector<PresetColourConversion>::const_iterator i = _colour_conversions.begin(); i != _colour_conversions.end(); ++i) {
 352                 i->as_xml (root->add_child ("ColourConversion"));
 353         }
 354
 355         for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
 356                 (*i)->as_xml (root->add_child ("Cinema"));
 357         }
 358
 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);
 364
 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");
 367
 368         root->add_child("MaximumJ2KBandwidth")->add_child_text (lexical_cast<string> (_maximum_j2k_bandwidth));
 369
 370         doc.write_to_file_formatted (file(false).string ());
 371 }
 372
 373 boost::filesystem::path
 374 Config::default_directory_or (boost::filesystem::path a) const
 375 {
 376         if (_default_directory.empty()) {
 377                 return a;
 378         }
 379
 380         boost::system::error_code ec;
 381         bool const e = boost::filesystem::exists (_default_directory, ec);
 382         if (ec || !e) {
 383                 return a;
 384         }
 385
 386         return _default_directory;
 387 }
 388
 389 void
 390 Config::drop ()
 391 {
 392         delete _instance;
 393         _instance = 0;
 394 }
 395
 396 void
 397 Config::changed ()
 398 {
 399         write ();
 400         Changed ();
 401 }