src/lib/config.cc

   1 /*
   2     Copyright (C) 2012 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 (200000000)
  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 {
  72         _allowed_dcp_frame_rates.push_back (24);
  73         _allowed_dcp_frame_rates.push_back (25);
  74         _allowed_dcp_frame_rates.push_back (30);
  75         _allowed_dcp_frame_rates.push_back (48);
  76         _allowed_dcp_frame_rates.push_back (50);
  77         _allowed_dcp_frame_rates.push_back (60);
  78
  79         _colour_conversions.push_back (PresetColourConversion (_("sRGB"), 2.4, true, libdcp::colour_matrix::srgb_to_xyz, 2.6));
  80         _colour_conversions.push_back (PresetColourConversion (_("sRGB non-linearised"), 2.4, false, libdcp::colour_matrix::srgb_to_xyz, 2.6));
  81         _colour_conversions.push_back (PresetColourConversion (_("Rec. 709"), 2.2, false, libdcp::colour_matrix::rec709_to_xyz, 2.6));
  82 }
  83
  84 void
  85 Config::read ()
  86 {
  87         LocaleGuard lg;
  88
  89         if (!boost::filesystem::exists (file (false))) {
  90                 read_old_metadata ();
  91                 return;
  92         }
  93
  94         cxml::Document f ("Config");
  95         f.read_file (file (false));
  96         optional<string> c;
  97
  98         optional<int> version = f.optional_number_child<int> ("Version");
  99
 100         _num_local_encoding_threads = f.number_child<int> ("NumLocalEncodingThreads");
 101         _default_directory = f.string_child ("DefaultDirectory");
 102
 103         boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
 104         if (!b) {
 105                 b = f.optional_number_child<int> ("ServerPortBase");
 106         }
 107         _server_port_base = b.get ();
 108
 109         boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
 110         _use_any_servers = u.get_value_or (true);
 111
 112         list<cxml::NodePtr> servers = f.node_children ("Server");
 113         for (list<cxml::NodePtr>::iterator i = servers.begin(); i != servers.end(); ++i) {
 114                 if ((*i)->node_children("HostName").size() == 1) {
 115                         _servers.push_back ((*i)->string_child ("HostName"));
 116                 } else {
 117                         _servers.push_back ((*i)->content ());
 118                 }
 119         }
 120
 121         _tms_ip = f.string_child ("TMSIP");
 122         _tms_path = f.string_child ("TMSPath");
 123         _tms_user = f.string_child ("TMSUser");
 124         _tms_password = f.string_child ("TMSPassword");
 125
 126         c = f.optional_string_child ("SoundProcessor");
 127         if (c) {
 128                 _sound_processor = SoundProcessor::from_id (c.get ());
 129         }
 130
 131         _language = f.optional_string_child ("Language");
 132
 133         c = f.optional_string_child ("DefaultContainer");
 134         if (c) {
 135                 _default_container = Ratio::from_id (c.get ());
 136         }
 137
 138         c = f.optional_string_child ("DefaultDCPContentType");
 139         if (c) {
 140                 _default_dcp_content_type = DCPContentType::from_dci_name (c.get ());
 141         }
 142
 143         _dcp_metadata.issuer = f.optional_string_child ("DCPMetadataIssuer").get_value_or ("");
 144         _dcp_metadata.creator = f.optional_string_child ("DCPMetadataCreator").get_value_or ("");
 145
 146         _default_dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
 147         _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
 148         _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
 149         _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
 150
 151         list<cxml::NodePtr> cc = f.node_children ("ColourConversion");
 152
 153         if (!cc.empty ()) {
 154                 _colour_conversions.clear ();
 155         }
 156
 157         for (list<cxml::NodePtr>::iterator i = cc.begin(); i != cc.end(); ++i) {
 158                 _colour_conversions.push_back (PresetColourConversion (*i));
 159         }
 160
 161         if (!version) {
 162                 /* Loading version 0 (before Rec. 709 was added as a preset).
 163                    Add it in.
 164                 */
 165                 _colour_conversions.push_back (PresetColourConversion (_("Rec. 709"), 2.2, false, libdcp::colour_matrix::rec709_to_xyz, 2.6));
 166         }
 167
 168         list<cxml::NodePtr> cin = f.node_children ("Cinema");
 169         for (list<cxml::NodePtr>::iterator i = cin.begin(); i != cin.end(); ++i) {
 170                 /* Slightly grotty two-part construction of Cinema here so that we can use
 171                    shared_from_this.
 172                 */
 173                 shared_ptr<Cinema> cinema (new Cinema (*i));
 174                 cinema->read_screens (*i);
 175                 _cinemas.push_back (cinema);
 176         }
 177
 178         _mail_server = f.string_child ("MailServer");
 179         _mail_user = f.optional_string_child("MailUser").get_value_or ("");
 180         _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
 181         _kdm_from = f.string_child ("KDMFrom");
 182         _kdm_email = f.string_child ("KDMEmail");
 183 }
 184
 185 void
 186 Config::read_old_metadata ()
 187 {
 188         /* XXX: this won't work with non-Latin filenames */
 189         ifstream f (file(true).string().c_str ());
 190         string line;
 191
 192         while (getline (f, line)) {
 193                 if (line.empty ()) {
 194                         continue;
 195                 }
 196
 197                 if (line[0] == '#') {
 198                         continue;
 199                 }
 200
 201                 size_t const s = line.find (' ');
 202                 if (s == string::npos) {
 203                         continue;
 204                 }
 205
 206                 string const k = line.substr (0, s);
 207                 string const v = line.substr (s + 1);
 208
 209                 if (k == N_("num_local_encoding_threads")) {
 210                         _num_local_encoding_threads = atoi (v.c_str ());
 211                 } else if (k == N_("default_directory")) {
 212                         _default_directory = v;
 213                 } else if (k == N_("server_port")) {
 214                         _server_port_base = atoi (v.c_str ());
 215                 } else if (k == N_("server")) {
 216                         vector<string> b;
 217                         split (b, v, is_any_of (" "));
 218                         if (b.size() == 2) {
 219                                 _servers.push_back (b[0]);
 220                         }
 221                 } else if (k == N_("tms_ip")) {
 222                         _tms_ip = v;
 223                 } else if (k == N_("tms_path")) {
 224                         _tms_path = v;
 225                 } else if (k == N_("tms_user")) {
 226                         _tms_user = v;
 227                 } else if (k == N_("tms_password")) {
 228                         _tms_password = v;
 229                 } else if (k == N_("sound_processor")) {
 230                         _sound_processor = SoundProcessor::from_id (v);
 231                 } else if (k == "language") {
 232                         _language = v;
 233                 } else if (k == "default_container") {
 234                         _default_container = Ratio::from_id (v);
 235                 } else if (k == "default_dcp_content_type") {
 236                         _default_dcp_content_type = DCPContentType::from_dci_name (v);
 237                 } else if (k == "dcp_metadata_issuer") {
 238                         _dcp_metadata.issuer = v;
 239                 } else if (k == "dcp_metadata_creator") {
 240                         _dcp_metadata.creator = v;
 241                 } else if (k == "dcp_metadata_issue_date") {
 242                         _dcp_metadata.issue_date = v;
 243                 }
 244
 245                 _default_dci_metadata.read_old_metadata (k, v);
 246         }
 247 }
 248
 249 /** @return Filename to write configuration to */
 250 boost::filesystem::path
 251 Config::file (bool old) const
 252 {
 253         boost::filesystem::path p;
 254         p /= g_get_user_config_dir ();
 255         boost::system::error_code ec;
 256         boost::filesystem::create_directory (p, ec);
 257         if (old) {
 258                 p /= ".dvdomatic";
 259         } else {
 260                 p /= "dcpomatic";
 261                 boost::filesystem::create_directory (p, ec);
 262                 p /= "config.xml";
 263         }
 264         return p;
 265 }
 266
 267 boost::filesystem::path
 268 Config::signer_chain_directory () const
 269 {
 270         boost::filesystem::path p;
 271         p /= g_get_user_config_dir ();
 272         p /= "dcpomatic";
 273         p /= "crypt";
 274         boost::filesystem::create_directories (p);
 275         return p;
 276 }
 277
 278 /** @return Singleton instance */
 279 Config *
 280 Config::instance ()
 281 {
 282         if (_instance == 0) {
 283                 _instance = new Config;
 284                 try {
 285                         _instance->read ();
 286                 } catch (exception& e) {
 287                         /* configuration load failed; never mind, just
 288                            stick with the default.
 289                         */
 290                         cerr << "dcpomatic: failed to load configuration (" << e.what() << ")\n";
 291                 } catch (...) {
 292                         cerr << "dcpomatic: failed to load configuration\n";
 293                 }
 294         }
 295
 296         return _instance;
 297 }
 298
 299 /** Write our configuration to disk */
 300 void
 301 Config::write () const
 302 {
 303         LocaleGuard lg;
 304
 305         xmlpp::Document doc;
 306         xmlpp::Element* root = doc.create_root_node ("Config");
 307
 308         root->add_child("Version")->add_child_text ("1");
 309         root->add_child("NumLocalEncodingThreads")->add_child_text (lexical_cast<string> (_num_local_encoding_threads));
 310         root->add_child("DefaultDirectory")->add_child_text (_default_directory.string ());
 311         root->add_child("ServerPortBase")->add_child_text (lexical_cast<string> (_server_port_base));
 312         root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
 313
 314         for (vector<string>::const_iterator i = _servers.begin(); i != _servers.end(); ++i) {
 315                 root->add_child("Server")->add_child_text (*i);
 316         }
 317
 318         root->add_child("TMSIP")->add_child_text (_tms_ip);
 319         root->add_child("TMSPath")->add_child_text (_tms_path);
 320         root->add_child("TMSUser")->add_child_text (_tms_user);
 321         root->add_child("TMSPassword")->add_child_text (_tms_password);
 322         if (_sound_processor) {
 323                 root->add_child("SoundProcessor")->add_child_text (_sound_processor->id ());
 324         }
 325         if (_language) {
 326                 root->add_child("Language")->add_child_text (_language.get());
 327         }
 328         if (_default_container) {
 329                 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
 330         }
 331         if (_default_dcp_content_type) {
 332                 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->dci_name ());
 333         }
 334         root->add_child("DCPMetadataIssuer")->add_child_text (_dcp_metadata.issuer);
 335         root->add_child("DCPMetadataCreator")->add_child_text (_dcp_metadata.creator);
 336
 337         _default_dci_metadata.as_xml (root->add_child ("DCIMetadata"));
 338
 339         root->add_child("DefaultStillLength")->add_child_text (lexical_cast<string> (_default_still_length));
 340         root->add_child("DefaultJ2KBandwidth")->add_child_text (lexical_cast<string> (_default_j2k_bandwidth));
 341         root->add_child("DefaultAudioDelay")->add_child_text (lexical_cast<string> (_default_audio_delay));
 342
 343         for (vector<PresetColourConversion>::const_iterator i = _colour_conversions.begin(); i != _colour_conversions.end(); ++i) {
 344                 i->as_xml (root->add_child ("ColourConversion"));
 345         }
 346
 347         for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
 348                 (*i)->as_xml (root->add_child ("Cinema"));
 349         }
 350
 351         root->add_child("MailServer")->add_child_text (_mail_server);
 352         root->add_child("MailUser")->add_child_text (_mail_user);
 353         root->add_child("MailPassword")->add_child_text (_mail_password);
 354         root->add_child("KDMFrom")->add_child_text (_kdm_from);
 355         root->add_child("KDMEmail")->add_child_text (_kdm_email);
 356
 357         doc.write_to_file_formatted (file(false).string ());
 358 }
 359
 360 boost::filesystem::path
 361 Config::default_directory_or (boost::filesystem::path a) const
 362 {
 363         if (_default_directory.empty()) {
 364                 return a;
 365         }
 366
 367         boost::system::error_code ec;
 368         bool const e = boost::filesystem::exists (_default_directory, ec);
 369         if (ec || !e) {
 370                 return a;
 371         }
 372
 373         return _default_directory;
 374 }
 375
 376 void
 377 Config::drop ()
 378 {
 379         delete _instance;
 380         _instance = 0;
 381 }