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 <libdcp/colour_matrix.h>
  26 #include <libcxml/cxml.h>
  27 #include "config.h"
  28 #include "server.h"
  29 #include "scaler.h"
  30 #include "filter.h"
  31 #include "ratio.h"
  32 #include "dcp_content_type.h"
  33 #include "sound_processor.h"
  34 #include "colour_conversion.h"
  35 #include "cinema.h"
  36 #include "util.h"
  37
  38 #include "i18n.h"
  39
  40 using std::vector;
  41 using std::ifstream;
  42 using std::string;
  43 using std::ofstream;
  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
  52 Config* Config::_instance = 0;
  53
  54 /** Construct default configuration */
  55 Config::Config ()
  56         : _num_local_encoding_threads (max (2U, boost::thread::hardware_concurrency()))
  57         , _server_port_base (6192)
  58         , _tms_path (".")
  59         , _sound_processor (SoundProcessor::from_id (N_("dolby_cp750")))
  60         , _default_still_length (10)
  61         , _default_container (Ratio::from_id ("185"))
  62         , _default_dcp_content_type (DCPContentType::from_dci_name ("TST"))
  63         , _default_j2k_bandwidth (200000000)
  64         , _kdm_email (
  65                 "Dear Projectionist\n\nPlease find attached KDMs for $CPL_NAME.\n\nBest regards,\nDCP-o-matic"
  66                 )
  67 {
  68         _allowed_dcp_frame_rates.push_back (24);
  69         _allowed_dcp_frame_rates.push_back (25);
  70         _allowed_dcp_frame_rates.push_back (30);
  71         _allowed_dcp_frame_rates.push_back (48);
  72         _allowed_dcp_frame_rates.push_back (50);
  73         _allowed_dcp_frame_rates.push_back (60);
  74
  75         _colour_conversions.push_back (PresetColourConversion (_("sRGB"), 2.4, true, libdcp::colour_matrix::srgb_to_xyz, 2.6));
  76         _colour_conversions.push_back (PresetColourConversion (_("sRGB non-linearised"), 2.4, false, libdcp::colour_matrix::srgb_to_xyz, 2.6));
  77         _colour_conversions.push_back (PresetColourConversion (_("Rec. 709"), 2.2, false, libdcp::colour_matrix::rec709_to_xyz, 2.6));
  78 }
  79
  80 void
  81 Config::read ()
  82 {
  83         LocaleGuard lg;
  84
  85         if (!boost::filesystem::exists (file (false))) {
  86                 read_old_metadata ();
  87                 return;
  88         }
  89
  90         cxml::Document f ("Config");
  91         f.read_file (file (false));
  92         optional<string> c;
  93
  94         optional<int> version = f.optional_number_child<int> ("Version");
  95
  96         _num_local_encoding_threads = f.number_child<int> ("NumLocalEncodingThreads");
  97         _default_directory = f.string_child ("DefaultDirectory");
  98
  99         boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
 100         if (!b) {
 101                 b = f.optional_number_child<int> ("ServerPortBase");
 102         }
 103         _server_port_base = b.get ();
 104
 105         _tms_ip = f.string_child ("TMSIP");
 106         _tms_path = f.string_child ("TMSPath");
 107         _tms_user = f.string_child ("TMSUser");
 108         _tms_password = f.string_child ("TMSPassword");
 109
 110         c = f.optional_string_child ("SoundProcessor");
 111         if (c) {
 112                 _sound_processor = SoundProcessor::from_id (c.get ());
 113         }
 114
 115         _language = f.optional_string_child ("Language");
 116
 117         c = f.optional_string_child ("DefaultContainer");
 118         if (c) {
 119                 _default_container = Ratio::from_id (c.get ());
 120         }
 121
 122         c = f.optional_string_child ("DefaultDCPContentType");
 123         if (c) {
 124                 _default_dcp_content_type = DCPContentType::from_dci_name (c.get ());
 125         }
 126
 127         _dcp_metadata.issuer = f.optional_string_child ("DCPMetadataIssuer").get_value_or ("");
 128         _dcp_metadata.creator = f.optional_string_child ("DCPMetadataCreator").get_value_or ("");
 129
 130         _default_dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
 131         _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
 132         _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
 133
 134         list<shared_ptr<cxml::Node> > cc = f.node_children ("ColourConversion");
 135
 136         if (!cc.empty ()) {
 137                 _colour_conversions.clear ();
 138         }
 139
 140         for (list<shared_ptr<cxml::Node> >::iterator i = cc.begin(); i != cc.end(); ++i) {
 141                 _colour_conversions.push_back (PresetColourConversion (*i));
 142         }
 143
 144         if (!version) {
 145                 /* Loading version 0 (before Rec. 709 was added as a preset).
 146                    Add it in.
 147                 */
 148                 _colour_conversions.push_back (PresetColourConversion (_("Rec. 709"), 2.2, false, libdcp::colour_matrix::rec709_to_xyz, 2.6));
 149         }
 150
 151         list<shared_ptr<cxml::Node> > cin = f.node_children ("Cinema");
 152         for (list<shared_ptr<cxml::Node> >::iterator i = cin.begin(); i != cin.end(); ++i) {
 153                 /* Slightly grotty two-part construction of Cinema here so that we can use
 154                    shared_from_this.
 155                 */
 156                 shared_ptr<Cinema> cinema (new Cinema (*i));
 157                 cinema->read_screens (*i);
 158                 _cinemas.push_back (cinema);
 159         }
 160
 161         _mail_server = f.string_child ("MailServer");
 162         _kdm_from = f.string_child ("KDMFrom");
 163         _kdm_email = f.string_child ("KDMEmail");
 164 }
 165
 166 void
 167 Config::read_old_metadata ()
 168 {
 169         ifstream f (file(true).string().c_str ());
 170         string line;
 171
 172         while (getline (f, line)) {
 173                 if (line.empty ()) {
 174                         continue;
 175                 }
 176
 177                 if (line[0] == '#') {
 178                         continue;
 179                 }
 180
 181                 size_t const s = line.find (' ');
 182                 if (s == string::npos) {
 183                         continue;
 184                 }
 185
 186                 string const k = line.substr (0, s);
 187                 string const v = line.substr (s + 1);
 188
 189                 if (k == N_("num_local_encoding_threads")) {
 190                         _num_local_encoding_threads = atoi (v.c_str ());
 191                 } else if (k == N_("default_directory")) {
 192                         _default_directory = v;
 193                 } else if (k == N_("server_port")) {
 194                         _server_port_base = atoi (v.c_str ());
 195                 } else if (k == N_("tms_ip")) {
 196                         _tms_ip = v;
 197                 } else if (k == N_("tms_path")) {
 198                         _tms_path = v;
 199                 } else if (k == N_("tms_user")) {
 200                         _tms_user = v;
 201                 } else if (k == N_("tms_password")) {
 202                         _tms_password = v;
 203                 } else if (k == N_("sound_processor")) {
 204                         _sound_processor = SoundProcessor::from_id (v);
 205                 } else if (k == "language") {
 206                         _language = v;
 207                 } else if (k == "default_container") {
 208                         _default_container = Ratio::from_id (v);
 209                 } else if (k == "default_dcp_content_type") {
 210                         _default_dcp_content_type = DCPContentType::from_dci_name (v);
 211                 } else if (k == "dcp_metadata_issuer") {
 212                         _dcp_metadata.issuer = v;
 213                 } else if (k == "dcp_metadata_creator") {
 214                         _dcp_metadata.creator = v;
 215                 } else if (k == "dcp_metadata_issue_date") {
 216                         _dcp_metadata.issue_date = v;
 217                 }
 218
 219                 _default_dci_metadata.read_old_metadata (k, v);
 220         }
 221 }
 222
 223 /** @return Filename to write configuration to */
 224 boost::filesystem::path
 225 Config::file (bool old) const
 226 {
 227         boost::filesystem::path p;
 228         p /= g_get_user_config_dir ();
 229         boost::system::error_code ec;
 230         boost::filesystem::create_directory (p, ec);
 231         if (old) {
 232                 p /= ".dvdomatic";
 233         } else {
 234                 p /= "dcpomatic";
 235                 boost::filesystem::create_directory (p, ec);
 236                 p /= "config.xml";
 237         }
 238         return p;
 239 }
 240
 241 boost::filesystem::path
 242 Config::signer_chain_directory () const
 243 {
 244         boost::filesystem::path p;
 245         p /= g_get_user_config_dir ();
 246         p /= "dcpomatic";
 247         p /= "crypt";
 248         boost::filesystem::create_directories (p);
 249         return p;
 250 }
 251
 252 /** @return Singleton instance */
 253 Config *
 254 Config::instance ()
 255 {
 256         if (_instance == 0) {
 257                 _instance = new Config;
 258                 try {
 259                         _instance->read ();
 260                 } catch (exception& e) {
 261                         /* configuration load failed; never mind, just
 262                            stick with the default.
 263                         */
 264                         cerr << "dcpomatic: failed to load configuration (" << e.what() << ")\n";
 265                 } catch (...) {
 266                         cerr << "dcpomatic: failed to load configuration\n";
 267                 }
 268         }
 269
 270         return _instance;
 271 }
 272
 273 /** Write our configuration to disk */
 274 void
 275 Config::write () const
 276 {
 277         LocaleGuard lg;
 278
 279         xmlpp::Document doc;
 280         xmlpp::Element* root = doc.create_root_node ("Config");
 281
 282         root->add_child("Version")->add_child_text ("1");
 283         root->add_child("NumLocalEncodingThreads")->add_child_text (lexical_cast<string> (_num_local_encoding_threads));
 284         root->add_child("DefaultDirectory")->add_child_text (_default_directory.string ());
 285         root->add_child("ServerPortBase")->add_child_text (lexical_cast<string> (_server_port_base));
 286         root->add_child("TMSIP")->add_child_text (_tms_ip);
 287         root->add_child("TMSPath")->add_child_text (_tms_path);
 288         root->add_child("TMSUser")->add_child_text (_tms_user);
 289         root->add_child("TMSPassword")->add_child_text (_tms_password);
 290         if (_sound_processor) {
 291                 root->add_child("SoundProcessor")->add_child_text (_sound_processor->id ());
 292         }
 293         if (_language) {
 294                 root->add_child("Language")->add_child_text (_language.get());
 295         }
 296         if (_default_container) {
 297                 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
 298         }
 299         if (_default_dcp_content_type) {
 300                 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->dci_name ());
 301         }
 302         root->add_child("DCPMetadataIssuer")->add_child_text (_dcp_metadata.issuer);
 303         root->add_child("DCPMetadataCreator")->add_child_text (_dcp_metadata.creator);
 304
 305         _default_dci_metadata.as_xml (root->add_child ("DCIMetadata"));
 306
 307         root->add_child("DefaultStillLength")->add_child_text (lexical_cast<string> (_default_still_length));
 308         root->add_child("DefaultJ2KBandwidth")->add_child_text (lexical_cast<string> (_default_j2k_bandwidth));
 309
 310         for (vector<PresetColourConversion>::const_iterator i = _colour_conversions.begin(); i != _colour_conversions.end(); ++i) {
 311                 i->as_xml (root->add_child ("ColourConversion"));
 312         }
 313
 314         for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
 315                 (*i)->as_xml (root->add_child ("Cinema"));
 316         }
 317
 318         root->add_child("MailServer")->add_child_text (_mail_server);
 319         root->add_child("KDMFrom")->add_child_text (_kdm_from);
 320         root->add_child("KDMEmail")->add_child_text (_kdm_email);
 321
 322         doc.write_to_file_formatted (file(false).string ());
 323 }
 324
 325 boost::filesystem::path
 326 Config::default_directory_or (boost::filesystem::path a) const
 327 {
 328         if (_default_directory.empty() || !boost::filesystem::exists (_default_directory)) {
 329                 return a;
 330         }
 331
 332         return _default_directory;
 333 }
 334
 335 void
 336 Config::drop ()
 337 {
 338         delete _instance;
 339         _instance = 0;
 340 }